Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKLinkCollection

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKSequentialCollection
        |
        +--com.ibm.mm.sdk.common.DKLinkCollection
All Implemented Interfaces:
dkCollection, DKConstant, DKMessageId, java.io.Serializable

public class DKLinkCollection
extends DKSequentialCollection
implements DKConstant, DKMessageId, java.io.Serializable

DKLinkCollection is a subclass of sequential collection. The main purpose of this class is for holding a group of DKLink objects each of which represent a link relationship between two item DDOs. The instance of this class containing child DDOs is used as the data-item value of the parent DDO.

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
DKLinkCollection()
          Constructs a DKLinkCollection object.
 
Method Summary
 void addMember(DKLink link)
          Adds a link object to the link collection as well to the persistent store.
 dkIterator createInboundIterator()
          Creates a new inbound iterator for this collection.
 dkIterator createOutboundIterator()
          Creates a new outbound iterator for this collection.
 void removeAllMembers()
          Removes a collection links and removes the links from the datastore
 void removeMember(DKLink link)
          Removes a link object from the link collection as well as from the persistent store.
 
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

DKLinkCollection

public DKLinkCollection()
Constructs a DKLinkCollection object.
Method Detail

addMember

public void addMember(DKLink link)
               throws DKException,
                      java.lang.Exception
Adds a link object to the link collection as well to the persistent store.
Parameters:
link - a link object
Throws:
DKException - if a problem is encountered
java.lang.Exception - if a problem is encountered

removeMember

public void removeMember(DKLink link)
                  throws DKException,
                         java.lang.Exception
Removes a link object from the link collection as well as from the persistent store.
Parameters:
link - a link object
Throws:
DKException - if a problem is encountered
java.lang.Exception - if a problem is encountered

removeAllMembers

public void removeAllMembers()
                      throws DKException,
                             java.lang.Exception
Removes a collection links and removes the links from the datastore
Parameters:
link - a link object

createOutboundIterator

public dkIterator createOutboundIterator()
Creates a new outbound iterator for this collection.
Returns:
an iterator

createInboundIterator

public dkIterator createInboundIterator()
Creates a new inbound iterator for this collection.
Returns:
an iterator

EIP Java APIs

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