Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKMatchesInfoTS

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

public class DKMatchesInfoTS
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
DKMatchesInfoTS()
          Constructs the match information and initializes it.
 
Method Summary
 void addSection(DKMatchesDocSectionTS section)
          Adds a document section.
 java.lang.String getDocumentName()
          Gets the document name.
 java.lang.String getObjectType()
          Gets the type of this object.
 dkDataObjectBase getParent()
          Gets the parent object
 DKMatchesDocSectionTS getSection(int sectionIndex)
          Gets the document section.
 int numberOfSections()
          Gets the number of sections in the document.
 void setDocumentName(java.lang.String docName)
          Sets the document name.
 void setParent(dkDataObjectBase parentObject)
          Sets the parent object
 
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

DKMatchesInfoTS

public DKMatchesInfoTS()
Constructs the match information 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

getDocumentName

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

setDocumentName

public void setDocumentName(java.lang.String docName)
Sets the document name.
Parameters:
text - the document name

numberOfSections

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

getSection

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

addSection

public void addSection(DKMatchesDocSectionTS section)
Adds a document section.
Parameters:
section - a document section

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.