Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKMatchesDocSectionTS

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

public class DKMatchesDocSectionTS
extends dkAbstractDataObjectBase
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
DKMatchesDocSectionTS()
          Constructs a document section and initializes it.
 
Method Summary
 void addParagraph(DKMatchesParagraphTS paragraph)
          Adds a document paragraph.
 java.lang.String getObjectType()
          Gets the type of this object.
 DKMatchesParagraphTS getParagraph(int paragraphIndex)
          Gets the document paragraph.
 dkDataObjectBase getParent()
          Gets the parent object
 java.lang.String getSectionName()
          Gets the document section name.
 int numberOfParagraphs()
          Gets the number of document paragraphs in the section.
 void setParent(dkDataObjectBase parentObject)
          Sets the parent object
 void setSectionName(java.lang.String sectionName)
          Sets the document section name.
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDataObjectBase
getRootObject, protocol, setRootObject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKMatchesDocSectionTS

public DKMatchesDocSectionTS()
Constructs a document section and initializes it.
Method Detail

getObjectType

public java.lang.String getObjectType()
Gets the type of this object.
Overrides:
getObjectType in class dkAbstractDataObjectBase
Returns:
the object type

getSectionName

public java.lang.String getSectionName()
Gets the document section name.
Returns:
the document section name

setSectionName

public void setSectionName(java.lang.String sectionName)
Sets the document section name.
Parameters:
text - the document section name

numberOfParagraphs

public int numberOfParagraphs()
Gets the number of document paragraphs in the section.
Returns:
number of paragraphs

getParagraph

public DKMatchesParagraphTS getParagraph(int paragraphIndex)
                                  throws DKException
Gets the document paragraph. The paragraphIndex is from 1 to the number of paragraphs. If the document paragraph is not found a null is returned.
Parameters:
paragraphIndex - the paragraph index
Returns:
a document paragraph

addParagraph

public void addParagraph(DKMatchesParagraphTS paragraph)
Adds a document paragraph.
Parameters:
paragraph - a document paragraph

getParent

public dkDataObjectBase getParent()
Gets the parent object
Overrides:
getParent in class dkAbstractDataObjectBase
Returns:
the parent object. Returns null if no parent

setParent

public void setParent(dkDataObjectBase parentObject)
Sets the parent object
Overrides:
setParent in class dkAbstractDataObjectBase
Parameters:
parent - the parent object

EIP Java APIs

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