Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKParts

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKSequentialCollection
        |
        +--com.ibm.mm.sdk.common.DKParts
All Implemented Interfaces:
dkCollection, DKConstant, DKMessageId, java.io.Serializable
Direct Known Subclasses:
DKSegmentedParts

public class DKParts
extends DKSequentialCollection
implements DKConstant, java.io.Serializable

DKParts is a subclass of sequential collection. Its purpose is to hold part XDO members of a document object. The DDO representing a document has an attribute with reserved name of DKParts, its value is a reference to the DKParts collection.

DKParts inherits the public interface of sequential collection, but internally it keeps track of member addition and deletion (to be reflected when the DDO is saved to the back-end datastore). In addition to the inherited methods, DKParts has two additional methods: addMember() and removeMember().

See Also:
Serialized Form

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.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKParts()
          Constructs a DKParts object.
 
Method Summary
 void addMember(DKDDO item, dkXDO member)
          Add a new member into this parts collection and reflects the results immediately in the datastore, i.e.
 dkCollection getAffiliatedTypes(int affiliatedType)
          Gets the specified affiliated type objects from this part collection.
 void removeMember(DKDDO item, dkXDO member)
          Removes a member from this parts collection and reflects the results immediately in the datastore, i.e.
 
Methods inherited from class com.ibm.mm.sdk.common.DKSequentialCollection
addElement, cardinality, createIterator, getAssociatedAttrName, getName, getOwner, getSortFunction, insertElementAt, removeAllElements, removeElementAt, replaceElementAt, retrieveElementAt, setName, setSortFunction, sort, sort, sort
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.mm.sdk.common.dkCollection
addAllElements
 

Constructor Detail

DKParts

public DKParts()
Constructs a DKParts object.
Method Detail

getAffiliatedTypes

public dkCollection getAffiliatedTypes(int affiliatedType)
                                throws DKException,
                                       java.lang.Exception
Gets the specified affiliated type objects from this part collection. Examples of affiliated types are DK_CM_ANNOTATION, DK_CM_NOTE, etc.
Parameters:
affiliatedType - the desired affiliated type to extract.
Returns:
a collection of xdo objects having the specified affiliated types

addMember

public void addMember(DKDDO item,
                      dkXDO member)
               throws DKException,
                      java.lang.Exception
Add a new member into this parts collection and reflects the results immediately in the datastore, i.e. make it persistent. The new member must not exists in the persistent store. At the end of the operation, the new member will be in this DKParts collection in-memory, as well as in the persistent item representation in the datastore. This operation has the same effect as the sequencing of member.add() and this.addElement(member), where member is the part XDO and this is the collection of parts (DKParts) in this item.
Parameters:
item - the data object that contains this parts collection
member - the member to be added to this parts collection

removeMember

public void removeMember(DKDDO item,
                         dkXDO member)
                  throws DKException,
                         java.lang.Exception
Removes a member from this parts collection and reflects the results immediately in the datastore, i.e. make it persistent. At the end of the operation, the member object will not be in this DKParts collection in-memory, and it will also be removed from the persistent item representation in the datastore. This operation has the same effect as the sequencing of this.removeElement(member) and member.del(), where member is the part XDO and this is the collection of parts (DKParts) in this item.
Parameters:
item - the data object that contains this parts collection
member - thr member to be removed from this parts collection

EIP Java APIs

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