com.ibm.mm.sdk.common

Class DKChildCollection

java.lang.Object

com.ibm.mm.sdk.common.DKSequentialCollection

com.ibm.mm.sdk.common.DKChildCollection

All Implemented Interfaces:

dkCollection, java.io.Serializable

public class DKChildCollection
extends DKSequentialCollection
implements java.io.Serializable

DKChildCollection is a subclass of sequential collection. The main purpose of this class is for holding a group of DDOs which are children of a parent DDO. The instance of this class containing child DDOs is used as the data-item value of the parent DDO.

See Also:

DKSequentialCollection, Serializable, 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
DKChildCollection() Constructs a DKChildCollection object.
DKChildCollection(DKDDO parentFolderDDO) Constructs a DKChildCollection object with a parent folder DDO.

Method Summary

Modifier and Type	Method and Description
DKDDO	getParentFolderDDO() Gets the parent folder DDO.
void	removeAllElements() Removes all elements in the collection.
void	setParentFolderDDO(DKDDO parentFolderDDO) Sets the parent folder DDO.

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

DKChildCollection

public DKChildCollection()

Constructs a DKChildCollection object.

DKChildCollection

public DKChildCollection(DKDDO parentFolderDDO)

Constructs a DKChildCollection object with a parent folder DDO.

Parameters:

parentFolderDDO - the parent folder DDO that owns this child collection

Method Detail

getParentFolderDDO

public DKDDO getParentFolderDDO()

Gets the parent folder DDO.

Returns:

the parent folder DDO

setParentFolderDDO

public void setParentFolderDDO(DKDDO parentFolderDDO)

Sets the parent folder DDO.

Parameters:

parentFolderDDO - the parent folder DDO to set

removeAllElements

public void removeAllElements()
                       throws DKUsageError

Removes all elements in the collection. Invalidates all other iterators.

C++ Memory Management:
Instances of DKChildCollection will free the memory for all elements when this method is used. You do not need to free the memory yourself. If you want to transfer ownership of the objects, you must use removeElementAt() instead.

Note that this only applies to particular subclasses of DKSequentialCollection, such as DKChildCollection and does not necessarily apply to all objects implementing the dkCollection interface or parent class DKSequentialCollection.

Specified by:

removeAllElements in interface dkCollection

Overrides:

removeAllElements in class DKSequentialCollection

Throws:

DKUsageError - if an error occurs during removal