Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKMatchesParagraphTS

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

public class DKMatchesParagraphTS
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
DKMatchesParagraphTS()
          Constructs the match paragraph and initializes it.
 
Method Summary
 void addTextItem(DKMatchesTextItemTS textItem)
          Adds a document text item to the paragraph.
 int getCCSID()
          Gets the CCSID (coded character set id) for the paragraph.
 int getLanguageId()
          Gets the language id for the paragraph.
 java.lang.String getObjectType()
          Gets the type of this object.
 dkDataObjectBase getParent()
          Gets the parent object
 DKMatchesTextItemTS getTextItem(int textItemIndex)
          Gets the document text item.
 int numberOfTextItems()
          Gets the number of text items in the paragraph.
 void setCCSID(int ccsid)
          Sets the CCSID (coded character set id) for the paragraph.
 void setLanguageId(int langId)
          Sets the language id for the paragraph.
 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

DKMatchesParagraphTS

public DKMatchesParagraphTS()
Constructs the match paragraph 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

getCCSID

public int getCCSID()
Gets the CCSID (coded character set id) for the paragraph.
Returns:
the CCSID

setCCSID

public void setCCSID(int ccsid)
Sets the CCSID (coded character set id) for the paragraph.
Parameters:
ccsid - the coded character set id

getLanguageId

public int getLanguageId()
Gets the language id for the paragraph.
Returns:
the language id

setLanguageId

public void setLanguageId(int langId)
Sets the language id for the paragraph.
Parameters:
langId - the language id

numberOfTextItems

public int numberOfTextItems()
Gets the number of text items in the paragraph.
Returns:
number of text items

getTextItem

public DKMatchesTextItemTS getTextItem(int textItemIndex)
                                throws DKException
Gets the document text item. The textItemIndex is from 1 to the number of text items. If the document text item is not found a null is returned.
Parameters:
textItemIndex - the text item index
Returns:
a document text item

addTextItem

public void addTextItem(DKMatchesTextItemTS textItem)
Adds a document text item to the paragraph.
Parameters:
textItem - a document text item

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.