Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKFolderMgmtFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKFolderMgmtFed
All Implemented Interfaces:
java.io.Serializable

public class DKFolderMgmtFed
extends java.lang.Object
implements java.io.Serializable

This is the management class for handling federated folder objects

See Also:
Serialized Form

Constructor Summary
DKFolderMgmtFed()
          Default constructor
DKFolderMgmtFed(dkDatastore ds)
          Constructor with datastore reference
 
Method Summary
 void addFolder(DKDDO fedFolderObj)
          Adds a federated folder into the EIP persistent datastore
 DKDDO createFolder(java.lang.String fedEntityName)
          Creates an empty federated folder
 dkDatastore getDatastore()
          Gets the datastore object
 dkCollection getFolders(java.lang.String fedEntityName)
          Gets a list of federated folder objects for the given federated entity name
 void removeFolder(DKDDO fedFolderObj)
          Removes a federated folder from the EIP persistent datastore
 DKDDO retrieveFolder(java.lang.String pidString)
          Retrieves a federated folder from the EIP persistent datastore
 void setDatastore(dkDatastore ds)
          Sets the datastore object
 void updateFolder(DKDDO fedFolderObj)
          Adds a federated folder into the EIP persistent datastore - attributes update only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKFolderMgmtFed

public DKFolderMgmtFed()
Default constructor

DKFolderMgmtFed

public DKFolderMgmtFed(dkDatastore ds)
                throws DKException
Constructor with datastore reference
Parameters:
ds - dkDatastore - datastore object
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
                  throws DKException
Sets the datastore object
Parameters:
ds - dkDatastore - datastore object

getDatastore

public dkDatastore getDatastore()
Gets the datastore object
Returns:
dkDatastore object

createFolder

public DKDDO createFolder(java.lang.String fedEntityName)
                   throws DKException,
                          java.lang.Exception
Creates an empty federated folder
Parameters:
fedEntityName - name of the federated entity
Returns:
a DKDDO object containing shell for federated folder

getFolders

public dkCollection getFolders(java.lang.String fedEntityName)
                        throws DKException,
                               java.lang.Exception
Gets a list of federated folder objects for the given federated entity name
Parameters:
fedEntityName - name of the federated entity
Returns:
a dkCollection of DKDDO objects containing federated folders

addFolder

public void addFolder(DKDDO fedFolderObj)
               throws DKException,
                      java.lang.Exception
Adds a federated folder into the EIP persistent datastore
Parameters:
fedFolderObj - DKDDO object containing federated folder data
Returns:
a DKPid containing the persistent id of the federated folder
Throws:
DKException - if error occurs in the EIP server
java.lang.Exception - if communication between EIP server and client

updateFolder

public void updateFolder(DKDDO fedFolderObj)
                  throws DKException,
                         java.lang.Exception
Adds a federated folder into the EIP persistent datastore - attributes update only. For updating members in folder, please use DKFolderFed.addMember() and DKFolderFed.removeMember() methods.
Parameters:
fedFolderObj - DKDDO object containing federated folder data
Throws:
DKException - if error occurs in the EIP server
java.lang.Exception - if communication between EIP server and client

removeFolder

public void removeFolder(DKDDO fedFolderObj)
                  throws DKException,
                         java.lang.Exception
Removes a federated folder from the EIP persistent datastore
Parameters:
fedFolderObj - DKDDO object containing federated folder data
Throws:
DKException - if error occurs in the EIP server
java.lang.Exception - if communication between EIP server and client

retrieveFolder

public DKDDO retrieveFolder(java.lang.String pidString)
                     throws DKException,
                            java.lang.Exception
Retrieves a federated folder from the EIP persistent datastore
Parameters:
fedFolderObj - DKDDO object containing federated folder data
Throws:
DKException - if error occurs in the EIP server
java.lang.Exception - if communication between EIP server and client

EIP Java APIs

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