Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKFolder

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

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

DKFolder is a subclass of sequential collection. Its purpose is to hold a collection of document DDO and folder DDO, members of a folder DDO. The DDO representing a folder has an attribute with reserved name of DKFolder, its value is a reference to the DKFolder collection.

DKFolder 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, DKFolder 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
DKFolder()
          Constructs a DKFolder object.
 
Method Summary
 void addMember(DKDDO folder, DKDDO member)
          Add a new member to this folder and reflects the results immediately in the datastore, i.e.
 void removeMember(DKDDO folder, DKDDO member)
          Removes a member from this folder 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

DKFolder

public DKFolder()
Constructs a DKFolder object.
Method Detail

addMember

public void addMember(DKDDO folder,
                      DKDDO member)
               throws DKUsageError,
                      DKException
Add a new member to this folder and reflects the results immediately in the datastore, i.e. make it persistent. At the end of the operation, the new member will be in this DKFolder collection in-memory, as well as in the persistent folder representation in the datastore. In Digital Library, the member must exists (has been created) in the datastore before it can be added to a folder.
Parameters:
folder - a folder object
member - the member to be added to the folder

removeMember

public void removeMember(DKDDO folder,
                         DKDDO member)
                  throws DKUsageError,
                         DKException
Removes a member from this folder 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 DKFolder collection in-memory, and it will also be removed from the persistent folder representation in the datastore.
Parameters:
folder - a folder object
member - the member to be removed from the folder

EIP Java APIs

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