Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDocModelTS

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKDocModelTS
All Implemented Interfaces:
DKConstant, DKConstantDL, DKMessageId, DKMessageIdDL, java.io.Serializable

public class DKDocModelTS
extends java.lang.Object
implements DKConstantDL, DKMessageIdDL, java.io.Serializable

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDL
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdDL
DK_DL_MSG_INVNBR_TEXTMAPPING, DK_DL_MSG_MSGID_NOT_FOUND
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKDocModelTS()
          Constructs the doc model information and initializes it.
 
Method Summary
 void addDocSection(DKDocSectionTS docSection)
          Adds a document model section.
 int getCCSID()
          Gets the CCSID
 DKDocSectionTS getDocSection(int docSectionIndex)
          Gets the document section.
 java.lang.String getName()
          Gets the document model name.
 int numberOfDocSections()
          Gets the number of sections in the document model.
 void setCCSID(int docModelCCSID)
          Sets the CCSID
 void setName(java.lang.String docModelName)
          Sets the document model name.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKDocModelTS

public DKDocModelTS()
Constructs the doc model information and initializes it.
Method Detail

getCCSID

public int getCCSID()
Gets the CCSID
Returns:
the CCSID

setCCSID

public void setCCSID(int docModelCCSID)
Sets the CCSID
Parameters:
docModelCCSID - the CCSID

getName

public java.lang.String getName()
Gets the document model name.
Returns:
the document model name

setName

public void setName(java.lang.String docModelName)
Sets the document model name.
Parameters:
docModelName - the document model name

numberOfDocSections

public int numberOfDocSections()
Gets the number of sections in the document model.
Returns:
number of sections

getDocSection

public DKDocSectionTS getDocSection(int docSectionIndex)
                             throws DKException
Gets the document section. The docSectionIndex is from 1 to the number of sections. If the document model section is not found a null is returned.
Parameters:
docSectionIndex - the document model section index
Returns:
a document model section

addDocSection

public void addDocSection(DKDocSectionTS docSection)
Adds a document model section.
Parameters:
docSection - a document model section

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.