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, java.io.Serializable

public class DKLinkCollection
extends DKSequentialCollection

DKLinkCollection - Represents a collection of DKLink objects.

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.

This class supports two modes of operation:

• Member methods (addMember/removeMember): For adding/removing links one at a time with immediate persistence. Use when a small number of links are added or removed infrequently.
• Element methods (addElement/removeElement + update): For batching multiple updates together into a single persistent update. More efficient for bulk operations.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.mm.sdk.common.DKSequentialCollection

associatedAttrName, currentPosition, fileNetCollection, items, name, owner

Constructor Summary

Constructors

Constructor and Description
DKLinkCollection() Default constructor.
DKLinkCollection(DKDDO parentFolderDDO) Constructor with parent folder context for persistent member operations.
DKLinkCollection(DKDDO parentFolderDDO, DKDatastoreExtICM datastoreExt) Constructor with parent folder context and explicit extended datastore for persistent member operations.

Method Summary

Modifier and Type	Method and Description
void	addMember(DKLink link)
dkIterator	createInboundIterator() Deprecated. Replaced by DKSequentialCollection::createIterator() and compare the "owner" and "target" DDO PIDs yourself.
dkIterator	createOutboundIterator() Deprecated. Replaced by DKSequentialCollection::createIterator() and compare the "owner" and "source" DDO PIDs yourself.
void	removeAllElements() Removes all elements from the collection.
void	removeAllMembers()
void	removeMember(DKLink link)

Methods inherited from class com.ibm.mm.sdk.common.DKSequentialCollection

addAllElements, addElement, cardinality, createIterator, getAssociatedAttrName, getFileNetCollection, getName, getOwner, insertElementAt, nextElement, removeElementAt, replaceElementAt, reset, retrieveElementAt, setAssociatedAttrName, setFileNetCollection, setName, setOwner

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DKLinkCollection

public DKLinkCollection()

Default constructor.

DKLinkCollection

public DKLinkCollection(DKDDO parentFolderDDO)

Constructor with parent folder context for persistent member operations.

Parameters:

parentFolderDDO - parent folder DDO

DKLinkCollection

public DKLinkCollection(DKDDO parentFolderDDO,
                        DKDatastoreExtICM datastoreExt)

Constructor with parent folder context and explicit extended datastore for persistent member operations. This constructor allows using an extended datastore (DKDatastoreExtICM) for link operations.

Parameters:

parentFolderDDO - parent folder DDO

datastoreExt - the extended datastore to use for link operations (DKDatastoreExtICM)

Method Detail

addMember

public void addMember(DKLink link)
               throws DKException,
                      java.lang.Exception

Throws:

DKException

java.lang.Exception

removeMember

public void removeMember(DKLink link)
                  throws DKException,
                         java.lang.Exception

Throws:

DKException

java.lang.Exception

removeAllMembers

public void removeAllMembers()
                      throws DKException,
                             java.lang.Exception

Throws:

DKException

java.lang.Exception

removeAllElements

public void removeAllElements()
                       throws DKUsageError

Description copied from interface: dkCollection

Removes all elements from the collection.

Specified by:

removeAllElements in interface dkCollection

Overrides:

removeAllElements in class DKSequentialCollection

Throws:

DKUsageError - if the removal operation fails

createOutboundIterator

@Deprecated
public dkIterator createOutboundIterator()
                                              throws DKException

Deprecated. Replaced by DKSequentialCollection::createIterator() and compare the "owner" and "source" DDO PIDs yourself.

Creates an outbound iterator for this link collection.

Returns:

an iterator for outbound links

Throws:

DKException - if iterator creation fails

createInboundIterator

@Deprecated
public dkIterator createInboundIterator()
                                             throws DKException

Deprecated. Replaced by DKSequentialCollection::createIterator() and compare the "owner" and "target" DDO PIDs yourself.

Creates an inbound iterator for this link collection.

Returns:

an iterator for inbound links

Throws:

DKException - if iterator creation fails