Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDocRoutingServiceMgmtICM

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

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

The DKDocRoutingServiceMgmtICM class provides the provides the methods to manage the helper classes DKProcessICM, DKWorkNodeICM, and DKWorkListICM. The provided methods include the CRUD (create/retrieve/update/delete) methods for the classes mentioned above The DKDocRoutingServiceMgmtICM object can be accessed from the DKDocRoutingServiceICM object.

See Also:
DKDocRoutingServiceICM, Serialized Form

Constructor Summary
DKDocRoutingServiceMgmtICM(dkDatastore ds)
          Constructs and initializes a document routing management object associated with the specified datastore
 
Method Summary
 void add(DKProcessICM process)
          adds a new process definition to the persistent store
 void add(DKWorkListICM worklist)
          Adds a new worklist definition to the persistent store
 void add(DKWorkNodeICM wb)
          Adds a new work node definition to the persistent store
 void addProcessUserDefinedAttr(DKAttrDefICM attribute)
          add a user-defined attribute to the process table
 void addRouteListEntryUserDefinedAttr(DKAttrDefICM attribute)
          adds a user-defined attribute to the routing steps table
 void addWorkNodeUserDefinedAttr(DKAttrDefICM attribute)
          Adds a user-defined attribute to the work node table
 void clearItemTypeCache()
          Clears the item type cache associated with this document routing management object
 void clearProcessCache()
          Clears the process cache associated with this document routing management object
 void clearWorkListCache()
          Clears the work list cache associated with this document routing management object
 void clearWorkNodeCache()
          Clears the work node cache associated with this document routing management object
 void delProcess(java.lang.String name)
          deletes the process with the specified name from the persistent store
 void delProcessUserDefinedAttr(java.lang.String attr_name)
          Deletes a user-defined attribute from the process table This method is not supported in CM v.8
 void delRouteListEntryUserDefinedAttr(java.lang.String attr_name)
          Deletes a user-defined attribute from the routing steps table This method is not supported in CM v.8
 void delWorkList(java.lang.String name)
          deletes the worklist definition based on the specified name from the persistent store
 void delWorkNode(java.lang.String name)
          Deletes a work node definition based on the specified name from the persistent store
 void delWorkNodeUserDefinedAttr(java.lang.String attr_name)
          Deletes a user-defined attribute from the work node table This method is not supported in CM v.8
 java.lang.String getItemTypeName(int itemTypeID, dkIterator itIter)
          Retrieves the name for an item type name based on its identifier.
 dkCollection listProcesses()
          Retrieves a list of definitions for all the processes in the persistent store
 java.lang.String[] listProcessNames()
          Retrieves an array of names for all the processes in the persistent store
 java.lang.String[] listProcessUserDefinedAttrs()
          Retrieves an array of the names of all user-defined attributes from the process table
 java.lang.String[] listRouteListEntryUserDefinedAttrs()
          Retrieves an array of the names of all the user-defined attributes from the routing steps table
 java.lang.String[] listWorkListNames()
          Retrieves an array of names for all the worklists from the persistent store
 dkCollection listWorkLists()
          Retrieves a collection of worklist definitions from the persistent store
 java.lang.String[] listWorkNodeNames()
          Retrieves an array of names for all the work nodes from the persistent store
 dkCollection listWorkNodes()
          Retrieves a collection of work node definitions from the persistent store
 java.lang.String[] listWorkNodeUserDefinedAttrs()
          Lists the names of all user-defined attributes from the work node table
 DKProcessICM retrieveProcess(java.lang.String name)
          Retrieves a process definition based on the specified name from the persistent store
 DKAttrDefICM retrieveProcessUserDefinedAttr(java.lang.String attribute_name)
          retrieves a user-defined attribute from the process table
 DKAttrDefICM retrieveRouteListEntryUserDefinedAttr(java.lang.String attribute_name)
          retrieves a user-defined attribute from the routing steps table
 DKWorkListICM retrieveWorkList(java.lang.String name)
          Retrieves a worklist definition from the persistent store
 DKWorkNodeICM retrieveWorkNode(java.lang.String name)
          Retrieves a work node definition from the persistent store
 DKAttrDefICM retrieveWorkNodeUserDefinedAttr(java.lang.String attribute_name)
          Retrieve the definition of a user-defined attribute from the work node table
 void update(DKProcessICM process)
          updates the definition of the specified process in the persistent store
 void update(DKWorkListICM worklist)
          Updates the specified worklist definition in the persistent store
 void update(DKWorkNodeICM wn)
          Updates the specified work node definition in the persistent store
 void updateProcessUserDefinedAttr(DKAttrDefICM attribute)
          updates a user-defined attribute in the process table
 void updateRouteListEntryUserDefinedAttr(DKAttrDefICM attribute)
          updates the definition of a user-defined attribute in the routing steps table
 void updateWorkNodeUserDefinedAttr(DKAttrDefICM attribute)
          Updates the definition of a user-defined attribute in the work node table
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKDocRoutingServiceMgmtICM

public DKDocRoutingServiceMgmtICM(dkDatastore ds)
Constructs and initializes a document routing management object associated with the specified datastore

  DKDatastoreICM ds = new DKDatastoreICM();
  ds.connect("icmnlsdb", "icmadmin" ,"password" ,"");
  DKDocRoutingServiceMgmtICM docMgmt = new DKDocRoutingServiceMgmtICM(ds);
  
Parameters:
ds - datastore reference as an instance of DKDatastoreICM
See Also:
DKDatastoreICM, DKDocRoutingServiceICM, DKProcessICM, DKWorkNodeICM, DKWorkListICM
Method Detail

add

public void add(DKProcessICM process)
         throws DKException,
                java.lang.Exception
adds a new process definition to the persistent store

The following code assumes the process is an existing DKProcessICM object, docMgmt is an existing DKDocRoutingMgmtICM process.

  docMgmt.add(process);
  
Parameters:
process - the process definition to be added as an instance of DKProcessICM.
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKProcessICM

update

public void update(DKProcessICM process)
            throws DKException,
                   java.lang.Exception
updates the definition of the specified process in the persistent store

The following code assumes process is an existing DKProcessICM object, docMgmt is an existing DKDocRoutingMgmtICM process.

  docMgmt.update(process);
  
Parameters:
process - the process definition as an instance of DKProcessICM object that is to be updated
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKProcessICM

delProcess

public void delProcess(java.lang.String name)
                throws DKException,
                       java.lang.Exception
deletes the process with the specified name from the persistent store

The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object. "Process1" is the name of an existing process.

  docMgmt.delProcess("Process1");
  
Parameters:
name - the name of the process whose definition is to be deleted
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKProcessICM

retrieveProcess

public DKProcessICM retrieveProcess(java.lang.String name)
                             throws DKException,
                                    java.lang.Exception
Retrieves a process definition based on the specified name from the persistent store

The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object. "Process1" is the name of the process to be retrieved from the persistent datastore

  DKProcessICM process = docMgmt.retrieveProcess("Process1");
  
Parameters:
name - the name of the process whose definition is to be retrieved
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKProcessICM

listProcessNames

public java.lang.String[] listProcessNames()
                                    throws DKException,
                                           java.lang.Exception
Retrieves an array of names for all the processes in the persistent store

The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object.

  String [] processNames = docMgmt.listProcessNames();
  
Returns:
an array of names of all the defined processes as strings
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKProcessICM

listProcesses

public dkCollection listProcesses()
                           throws DKException,
                                  java.lang.Exception
Retrieves a list of definitions for all the processes in the persistent store

The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object.

  dkCollection coll = docMgmt.listProcesses();
  
Returns:
collection of process definitions as instances of DKProcessICM
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKProcessICM

addProcessUserDefinedAttr

public void addProcessUserDefinedAttr(DKAttrDefICM attribute)
                               throws DKException,
                                      java.lang.Exception
add a user-defined attribute to the process table
Parameters:
attribute - a DKAttrDefICM object to be added to the process table
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

delProcessUserDefinedAttr

public void delProcessUserDefinedAttr(java.lang.String attr_name)
                               throws DKException,
                                      java.lang.Exception
Deletes a user-defined attribute from the process table This method is not supported in CM v.8
Parameters:
attr_name - the name of the attribute to be removed from the process table
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

updateProcessUserDefinedAttr

public void updateProcessUserDefinedAttr(DKAttrDefICM attribute)
                                  throws DKException,
                                         java.lang.Exception
updates a user-defined attribute in the process table
Parameters:
attribute - a DKAttrDefICM object to be updated in the process table
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

retrieveProcessUserDefinedAttr

public DKAttrDefICM retrieveProcessUserDefinedAttr(java.lang.String attribute_name)
                                            throws DKException,
                                                   java.lang.Exception
retrieves a user-defined attribute from the process table
Parameters:
attribute_name - the name of a user-defined attribute to be retrieved from the process table
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

listProcessUserDefinedAttrs

public java.lang.String[] listProcessUserDefinedAttrs()
                                               throws DKException,
                                                      java.lang.Exception
Retrieves an array of the names of all user-defined attributes from the process table
Returns:
an array of user-defined attribute names as strings
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

addRouteListEntryUserDefinedAttr

public void addRouteListEntryUserDefinedAttr(DKAttrDefICM attribute)
                                      throws DKException,
                                             java.lang.Exception
adds a user-defined attribute to the routing steps table
Parameters:
attribute - a DKAttrDefICM object to be added to the routing steps table
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

delRouteListEntryUserDefinedAttr

public void delRouteListEntryUserDefinedAttr(java.lang.String attr_name)
                                      throws DKException,
                                             java.lang.Exception
Deletes a user-defined attribute from the routing steps table This method is not supported in CM v.8
Parameters:
attr_name - the name of the attribute to be removed from the routing steps table
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

updateRouteListEntryUserDefinedAttr

public void updateRouteListEntryUserDefinedAttr(DKAttrDefICM attribute)
                                         throws DKException,
                                                java.lang.Exception
updates the definition of a user-defined attribute in the routing steps table
Parameters:
attribute - a DKAttrDefICM object to be updated in the routing steps table
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

retrieveRouteListEntryUserDefinedAttr

public DKAttrDefICM retrieveRouteListEntryUserDefinedAttr(java.lang.String attribute_name)
                                                   throws DKException,
                                                          java.lang.Exception
retrieves a user-defined attribute from the routing steps table
Parameters:
attribute_name - the name of a user-defined attribute to be retrieved from the routing steps table
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

listRouteListEntryUserDefinedAttrs

public java.lang.String[] listRouteListEntryUserDefinedAttrs()
                                                      throws DKException,
                                                             java.lang.Exception
Retrieves an array of the names of all the user-defined attributes from the routing steps table
Returns:
an array of user-defined attribute names as strings
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

add

public void add(DKWorkNodeICM wb)
         throws DKException,
                java.lang.Exception
Adds a new work node definition to the persistent store

The following code assumes workNode is an existing DKWorkNodeICM object, docMgmt is an existing DKDocRoutingMgmtICM object.

  docMgmt.add(workNode);
  
Parameters:
wb - the work node definition to be added as an instance of DKWorkNodeICM
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKWorkNodeICM

update

public void update(DKWorkNodeICM wn)
            throws DKException,
                   java.lang.Exception
Updates the specified work node definition in the persistent store

The following code assumes workNode is an existing DKWorkNodeICM object, docMgmt is an existing DKDocRoutingMgmtICM object.

  docMgmt.update(workNode);
  
Parameters:
wn - the work node object whose definition is to be updated
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKWorkNodeICM

delWorkNode

public void delWorkNode(java.lang.String name)
                 throws DKException,
                        java.lang.Exception
Deletes a work node definition based on the specified name from the persistent store

The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object, and "WorkNode1" is the name of an existing work node.

  docMgmt.delWorkNode("WorkNode1");
  
Parameters:
name - the name of the work node object to be deleted
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKWorkNodeICM

retrieveWorkNode

public DKWorkNodeICM retrieveWorkNode(java.lang.String name)
                               throws DKException,
                                      java.lang.Exception
Retrieves a work node definition from the persistent store

The following code assumes "WorkNode1" is the name of an existing work node, docMgmt is an existing DKDocRoutingMgmtICM object.

  DKWorkNodeICM wn = docMgmt.retrieveWorkNode("WorkNode1");
  
Parameters:
name - the name of the work node object to be retrieved
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKWorkNodeICM

listWorkNodeNames

public java.lang.String[] listWorkNodeNames()
                                     throws DKException,
                                            java.lang.Exception
Retrieves an array of names for all the work nodes from the persistent store

The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object.

  String [] workNodeNames = docMgmt.listWorkNodeNames();
  
Returns:
an array of names for work nodes as strings
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

listWorkNodes

public dkCollection listWorkNodes()
                           throws DKException,
                                  java.lang.Exception
Retrieves a collection of work node definitions from the persistent store

The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object.

  dkCollection coll = docMgmt.listWorkNodes();
  
Returns:
collection of work node definitions as instances of DKWorkNodeICM
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs

addWorkNodeUserDefinedAttr

public void addWorkNodeUserDefinedAttr(DKAttrDefICM attribute)
                                throws DKException,
                                       java.lang.Exception
Adds a user-defined attribute to the work node table
Parameters:
attribute - a DKAttrDefICM object to be added to the work node table
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

delWorkNodeUserDefinedAttr

public void delWorkNodeUserDefinedAttr(java.lang.String attr_name)
                                throws DKException,
                                       java.lang.Exception
Deletes a user-defined attribute from the work node table This method is not supported in CM v.8
Parameters:
attr_name - the name of the attribute to be removed from the work node table
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

updateWorkNodeUserDefinedAttr

public void updateWorkNodeUserDefinedAttr(DKAttrDefICM attribute)
                                   throws DKException,
                                          java.lang.Exception
Updates the definition of a user-defined attribute in the work node table
Parameters:
attribute - a DKAttrDefICM object to be updated in the work node table
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

retrieveWorkNodeUserDefinedAttr

public DKAttrDefICM retrieveWorkNodeUserDefinedAttr(java.lang.String attribute_name)
                                             throws DKException,
                                                    java.lang.Exception
Retrieve the definition of a user-defined attribute from the work node table
Parameters:
attribute_name - the name of a user-defined attribute to be retrieved from the work node table
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

listWorkNodeUserDefinedAttrs

public java.lang.String[] listWorkNodeUserDefinedAttrs()
                                                throws DKException,
                                                       java.lang.Exception
Lists the names of all user-defined attributes from the work node table
Returns:
an array of user-defined attribute names
Throws:
DKException - when error occurs
java.lang.Exception - when error occurs

getItemTypeName

public java.lang.String getItemTypeName(int itemTypeID,
                                        dkIterator itIter)
                                 throws DKException,
                                        java.lang.Exception
Retrieves the name for an item type name based on its identifier.
Parameters:
itemTypeID - item type identifier
itIter - iterator to use for the name search
Returns:
item type name as a string

add

public void add(DKWorkListICM worklist)
         throws DKException,
                java.lang.Exception
Adds a new worklist definition to the persistent store

The following code assumes workList is an existing DKWorkListICM object, docMgmt is an existing DKDocRoutingMgmtICM object.

  docMgmt.add(workList);
  
Parameters:
worklist - a worklist definition as an instance of DKWorkListICM
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKWorkListICM

update

public void update(DKWorkListICM worklist)
            throws DKException,
                   java.lang.Exception
Updates the specified worklist definition in the persistent store

The following code assumes workList is an existing DKWorkListICM object, docMgmt is an existing DKDocRoutingMgmtICM object.

  docMgmt.update(workList);
  
Parameters:
worklist - the worklist definition as an instance of DKWorkListICM that is to be updated
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKWorkListICM

delWorkList

public void delWorkList(java.lang.String name)
                 throws DKException,
                        java.lang.Exception
deletes the worklist definition based on the specified name from the persistent store

The following code assumes "WorkList1" is the name of an existing work list in the database, docMgmt is an existing DKDocRoutingMgmtICM object.

  docMgmt.delWorkList("WorkList1");
  
Parameters:
name - the name of the worklist to be deleted
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKWorkListICM

retrieveWorkList

public DKWorkListICM retrieveWorkList(java.lang.String name)
                               throws DKException,
                                      java.lang.Exception
Retrieves a worklist definition from the persistent store

The following code assumes "WorkList1" is the name of an existing work list in the database, docMgmt is an existing DKDocRoutingMgmtICM object.

  docMgmt.retrieveWorkList("WorkList1");
  
Parameters:
name - the name of the work list object to be retrieved
Returns:
the work list definition as an instance of DKWorkListICM
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKWorkListICM

listWorkListNames

public java.lang.String[] listWorkListNames()
                                     throws DKException,
                                            java.lang.Exception
Retrieves an array of names for all the worklists from the persistent store

The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object.

  String [] names = docMgmt.listWorkListNames();
  
Returns:
an array of names for all the worklists
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKWorkListICM

listWorkLists

public dkCollection listWorkLists()
                           throws DKException,
                                  java.lang.Exception
Retrieves a collection of worklist definitions from the persistent store

The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object.

  dkCollection coll = docMgmt.listWorkLists();
  
Returns:
collection of the work list definitions as instances of DKWorkListICM
Throws:
DKException - when error occurs in the server
java.lang.Exception - when error occurs
See Also:
DKWorkListICM

clearProcessCache

public void clearProcessCache()
Clears the process cache associated with this document routing management object

clearWorkNodeCache

public void clearWorkNodeCache()
Clears the work node cache associated with this document routing management object

clearWorkListCache

public void clearWorkListCache()
Clears the work list cache associated with this document routing management object

clearItemTypeCache

public void clearItemTypeCache()
                        throws java.lang.Exception
Clears the item type cache associated with this document routing management object

EIP Java APIs

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