|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKDocRoutingServiceMgmtICM
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.
DKDocRoutingServiceICM
, Serialized FormConstructor 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 |
public DKDocRoutingServiceMgmtICM(dkDatastore ds)
DKDatastoreICM ds = new DKDatastoreICM(); ds.connect("icmnlsdb", "icmadmin" ,"password" ,""); DKDocRoutingServiceMgmtICM docMgmt = new DKDocRoutingServiceMgmtICM(ds);
ds
- datastore reference as an instance of DKDatastoreICMDKDatastoreICM
,
DKDocRoutingServiceICM
,
DKProcessICM
,
DKWorkNodeICM
,
DKWorkListICM
Method Detail |
public void add(DKProcessICM process) throws DKException, java.lang.Exception
The following code assumes the process is an existing DKProcessICM object, docMgmt is an existing DKDocRoutingMgmtICM process.
docMgmt.add(process);
process
- the process definition to be added as an instance of DKProcessICM.DKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKProcessICM
public void update(DKProcessICM process) throws DKException, java.lang.Exception
The following code assumes process is an existing DKProcessICM object, docMgmt is an existing DKDocRoutingMgmtICM process.
docMgmt.update(process);
process
- the process definition as an instance of DKProcessICM object that is to be updatedDKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKProcessICM
public void delProcess(java.lang.String name) throws DKException, java.lang.Exception
The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object. "Process1" is the name of an existing process.
docMgmt.delProcess("Process1");
name
- the name of the process whose definition is to be deletedDKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKProcessICM
public DKProcessICM retrieveProcess(java.lang.String name) throws DKException, java.lang.Exception
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");
name
- the name of the process whose definition is to be retrievedDKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKProcessICM
public java.lang.String[] listProcessNames() throws DKException, java.lang.Exception
The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object.
String [] processNames = docMgmt.listProcessNames();
DKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKProcessICM
public dkCollection listProcesses() throws DKException, java.lang.Exception
The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object.
dkCollection coll = docMgmt.listProcesses();
DKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKProcessICM
public void addProcessUserDefinedAttr(DKAttrDefICM attribute) throws DKException, java.lang.Exception
attribute
- a DKAttrDefICM object to be added to the process tableDKException
- when error occursjava.lang.Exception
- when error occurspublic void delProcessUserDefinedAttr(java.lang.String attr_name) throws DKException, java.lang.Exception
attr_name
- the name of the attribute to be removed from the process tableDKException
- when error occursjava.lang.Exception
- when error occurspublic void updateProcessUserDefinedAttr(DKAttrDefICM attribute) throws DKException, java.lang.Exception
attribute
- a DKAttrDefICM object to be updated in the process tableDKException
- when error occursjava.lang.Exception
- when error occurspublic DKAttrDefICM retrieveProcessUserDefinedAttr(java.lang.String attribute_name) throws DKException, java.lang.Exception
attribute_name
- the name of a user-defined attribute to be retrieved from the process tableDKException
- when error occursjava.lang.Exception
- when error occurspublic java.lang.String[] listProcessUserDefinedAttrs() throws DKException, java.lang.Exception
DKException
- when error occursjava.lang.Exception
- when error occurspublic void addRouteListEntryUserDefinedAttr(DKAttrDefICM attribute) throws DKException, java.lang.Exception
attribute
- a DKAttrDefICM object to be added to the routing steps tableDKException
- when error occursjava.lang.Exception
- when error occurspublic void delRouteListEntryUserDefinedAttr(java.lang.String attr_name) throws DKException, java.lang.Exception
attr_name
- the name of the attribute to be removed from the routing steps tableDKException
- when error occursjava.lang.Exception
- when error occurspublic void updateRouteListEntryUserDefinedAttr(DKAttrDefICM attribute) throws DKException, java.lang.Exception
attribute
- a DKAttrDefICM object to be updated in the routing steps tableDKException
- when error occursjava.lang.Exception
- when error occurspublic DKAttrDefICM retrieveRouteListEntryUserDefinedAttr(java.lang.String attribute_name) throws DKException, java.lang.Exception
attribute_name
- the name of a user-defined attribute to be retrieved from the routing steps tableDKException
- when error occursjava.lang.Exception
- when error occurspublic java.lang.String[] listRouteListEntryUserDefinedAttrs() throws DKException, java.lang.Exception
DKException
- when error occursjava.lang.Exception
- when error occurspublic void add(DKWorkNodeICM wb) throws DKException, java.lang.Exception
The following code assumes workNode is an existing DKWorkNodeICM object, docMgmt is an existing DKDocRoutingMgmtICM object.
docMgmt.add(workNode);
wb
- the work node definition to be added as an instance of DKWorkNodeICMDKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKWorkNodeICM
public void update(DKWorkNodeICM wn) throws DKException, java.lang.Exception
The following code assumes workNode is an existing DKWorkNodeICM object, docMgmt is an existing DKDocRoutingMgmtICM object.
docMgmt.update(workNode);
wn
- the work node object whose definition is to be updatedDKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKWorkNodeICM
public void delWorkNode(java.lang.String name) throws DKException, java.lang.Exception
The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object, and "WorkNode1" is the name of an existing work node.
docMgmt.delWorkNode("WorkNode1");
name
- the name of the work node object to be deletedDKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKWorkNodeICM
public DKWorkNodeICM retrieveWorkNode(java.lang.String name) throws DKException, java.lang.Exception
The following code assumes "WorkNode1" is the name of an existing work node, docMgmt is an existing DKDocRoutingMgmtICM object.
DKWorkNodeICM wn = docMgmt.retrieveWorkNode("WorkNode1");
name
- the name of the work node object to be retrievedDKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKWorkNodeICM
public java.lang.String[] listWorkNodeNames() throws DKException, java.lang.Exception
The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object.
String [] workNodeNames = docMgmt.listWorkNodeNames();
DKException
- when error occurs in the serverjava.lang.Exception
- when error occurspublic dkCollection listWorkNodes() throws DKException, java.lang.Exception
The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object.
dkCollection coll = docMgmt.listWorkNodes();
DKException
- when error occurs in the serverjava.lang.Exception
- when error occurspublic void addWorkNodeUserDefinedAttr(DKAttrDefICM attribute) throws DKException, java.lang.Exception
attribute
- a DKAttrDefICM object to be added to the work node tableDKException
- when error occursjava.lang.Exception
- when error occurspublic void delWorkNodeUserDefinedAttr(java.lang.String attr_name) throws DKException, java.lang.Exception
attr_name
- the name of the attribute to be removed from the work node tableDKException
- when error occursjava.lang.Exception
- when error occurspublic void updateWorkNodeUserDefinedAttr(DKAttrDefICM attribute) throws DKException, java.lang.Exception
attribute
- a DKAttrDefICM object to be updated in the work node tableDKException
- when error occursjava.lang.Exception
- when error occurspublic DKAttrDefICM retrieveWorkNodeUserDefinedAttr(java.lang.String attribute_name) throws DKException, java.lang.Exception
attribute_name
- the name of a user-defined attribute to be retrieved from the work node tableDKException
- when error occursjava.lang.Exception
- when error occurspublic java.lang.String[] listWorkNodeUserDefinedAttrs() throws DKException, java.lang.Exception
DKException
- when error occursjava.lang.Exception
- when error occurspublic java.lang.String getItemTypeName(int itemTypeID, dkIterator itIter) throws DKException, java.lang.Exception
itemTypeID
- item type identifieritIter
- iterator to use for the name searchpublic void add(DKWorkListICM worklist) throws DKException, java.lang.Exception
The following code assumes workList is an existing DKWorkListICM object, docMgmt is an existing DKDocRoutingMgmtICM object.
docMgmt.add(workList);
worklist
- a worklist definition as an instance of DKWorkListICMDKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKWorkListICM
public void update(DKWorkListICM worklist) throws DKException, java.lang.Exception
The following code assumes workList is an existing DKWorkListICM object, docMgmt is an existing DKDocRoutingMgmtICM object.
docMgmt.update(workList);
worklist
- the worklist definition as an instance of DKWorkListICM that is to be updatedDKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKWorkListICM
public void delWorkList(java.lang.String name) throws DKException, java.lang.Exception
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");
name
- the name of the worklist to be deletedDKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKWorkListICM
public DKWorkListICM retrieveWorkList(java.lang.String name) throws DKException, java.lang.Exception
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");
name
- the name of the work list object to be retrievedDKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKWorkListICM
public java.lang.String[] listWorkListNames() throws DKException, java.lang.Exception
The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object.
String [] names = docMgmt.listWorkListNames();
DKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKWorkListICM
public dkCollection listWorkLists() throws DKException, java.lang.Exception
The following code assumes docMgmt is an existing DKDocRoutingMgmtICM object.
dkCollection coll = docMgmt.listWorkLists();
DKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKWorkListICM
public void clearProcessCache()
public void clearWorkNodeCache()
public void clearWorkListCache()
public void clearItemTypeCache() throws java.lang.Exception
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |