|
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.DKDocRoutingServiceICM
The DKDocRoutingServiceICM represents a document routing service in Content Manager.It provides the methods for managing a process including starting, terminating, continuing, suspending and resuming a process. It also provides helper methods for listing work packages based on various selection criteria.A document routing service can be established by sequentially performing the following two operations. 1. connecting to a datastore associated with a Content Manager version 8 library server and 2. instantiating a DKDocRoutingServiceICM object that allows access to the document routing APIs To perform CRUD (create, retrieve, update, delete) operations on work nodes, work lists and processes, the user will need to use the DKDocRoutingServiceMgmtICM helper class.
DKDocRoutingServiceMgmtICM
, Serialized FormConstructor Summary | |
DKDocRoutingServiceICM(dkDatastore ds)
Constructs and initializes a document routing service object associated with the specified datastore |
Method Summary | |
boolean |
checkOutItemInWorkPackage(java.lang.String workpackage_pid)
Checks out the given item from the specified work package. |
DKHandle |
connection()
Returns the connection handle for this document routing service. |
java.lang.String |
continueProcess(java.lang.String pidString,
java.lang.String selection,
java.lang.String owner)
The continueProcess method will route the item referenced by the specified item persistent identifier (PID) in the specified work package from the current work node to the next work node as determined by the selection. |
java.lang.String |
continueProcess(java.lang.String pidString,
java.lang.String selection,
java.lang.String owner,
dkCollection container_data)
The continueProcess method will route the item referenced by the item persistent identifier (PID) in the specified work package from the current work node to the next work node that is determined by the selection. |
int |
getCount(java.lang.String worklist_name,
java.lang.String owner)
Retrieves the count of work packages in the specified work list for the specified owner. |
dkDatastore |
getDatastore()
Retrieves a reference to the datastore object associated with this document routing service. |
DKDocRoutingServiceMgmtICM |
getDocRoutingServiceMgmt()
Retrieves a reference to the document routing management helper object associated with this document routing service object. |
DKWorkPackageICM |
getNextWorkPackage(java.lang.String worklist_name,
java.lang.String owner)
Retrieve the next work package in the work list for the given owner and check it out. |
java.lang.String |
getNextWorkPackagePidString(java.lang.String worklist_name,
java.lang.String owner)
Retrieves the persistent identifier (PID) string for the next work package in the specified work list for the given owner. |
dkCollection |
getWorkPackageContainerData(java.lang.String workpackage_pid)
Retrieves the container data for the specified work package. |
java.lang.String |
getWorkPackageOwner(java.lang.String workpackage_pid)
Retrieves the owner for the specified work package. |
int |
getWorkPackagePriority(java.lang.String workpackage_pid)
Retrieves the priority of the specified work package |
boolean |
isConnected()
Returns a value that determines whether this service is connected to the persistent store or not. |
java.lang.String[] |
listWorkPackagePidStrings(java.lang.String worklist_name,
java.lang.String owner)
Retrieves an array of the persistent identifier (PID) strings for the work packages in the given work list for the given owner. |
java.lang.String[] |
listWorkPackagePidStringsWithItem(java.lang.String item_pid)
Retrieves an array of persistent identifier strings for work package that are associated with the specified item id |
dkCollection |
listWorkPackages(java.lang.String worklist_name,
java.lang.String owner)
Retrieves a collection of the work packages in the given work list for the given owner.The work packages are not checked out by performing this operation |
dkCollection |
listWorkPackagesWithItem(java.lang.String item_pid)
Retrieves a list of the work packages associated with the specified item |
void |
resumeProcess(java.lang.String pidString)
The resumeProcess method will reset the suspend flag of the specified work package to false even before the suspension reaches the specified duration and the resume list is satisfied. |
DKWorkPackageICM |
retrieveWorkPackage(java.lang.String pidString,
boolean checkOut)
Retrieves the work package referred to by the pidString parameter as a DKWorkPackageICM reference . |
java.lang.String |
serviceCategory()
Returns the category for this document routing service |
java.lang.String |
serviceId()
Retrieves the identifier for this document routing service |
java.lang.String |
serviceName()
Returns the name of this document routing service. |
java.lang.String |
serviceType()
Returns the type for this document routing service. |
void |
setDatastore(dkDatastore ds)
Sets a reference to the datastore object associated with this document routing service. |
void |
setServiceName(java.lang.String service_name)
Sets the name for this document routing service. |
void |
setWorkPackageContainerData(java.lang.String workpackage_pid,
dkCollection container_data)
Sets the container data for the specified work package. |
void |
setWorkPackageOwner(java.lang.String workpackage_pid,
java.lang.String owner)
Sets the owner name for the specified work package. |
void |
setWorkPackagePriority(java.lang.String workpackage_pid,
int priority)
Sets the priority of the specified work package. |
java.lang.String |
startProcess(java.lang.String processName,
java.lang.String pidString,
int priority,
java.lang.String owner)
The startProcess method will start a process with the specified process name, item persistent identifier (PID), priority and owner name. |
java.lang.String |
startProcess(java.lang.String processName,
java.lang.String pidString,
int priority,
java.lang.String owner,
dkCollection container_data)
The startProcess method will start a process with the specified process name, item persistent identifier (PID), priority, owner name, and container data. |
void |
suspendProcess(java.lang.String pidString,
int duration,
dkCollection resume_list)
The suspendProcess method will suspend a process with the specified work package persistent identifier (PID) for a duration (specified in minutes) or for a given resume list. |
void |
terminateProcess(java.lang.String pidString)
The terminateProcess method will terminate the work package specified in the persistent identifier (PID). |
java.lang.String |
userName()
Returns the name of the user connected to this document routing service. |
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.dkService |
addExtension, connect, destroy, disconnect, getExtension, listExtensionNames, removeExtension, setUserName |
Constructor Detail |
public DKDocRoutingServiceICM(dkDatastore ds) throws DKException, java.lang.Exception
DKDatstoreICM ds = new DKDatastoreICM(); ds.connect("icmnlsdb", "icmadmin" ,"password" ,""); DKDocRoutingServiceICM doc = new DKDocRoutingServiceMgmtICM(ds);
ds
- datastore reference as an instance of DKDatastoreICMDKException
- when error occurs in the serverjava.lang.Exception
- when error occursDKDatastoreICM
,
DKDocRoutingServiceMgmtICM
Method Detail |
public java.lang.String serviceName() throws java.lang.Exception
serviceName
in interface dkService
java.lang.Exception
- when error occurspublic java.lang.String serviceType() throws java.lang.Exception
serviceType
in interface dkService
java.lang.Exception
- when error occurspublic java.lang.String serviceId() throws java.lang.Exception
serviceId
in interface dkService
java.lang.Exception
- when error occurspublic java.lang.String serviceCategory() throws java.lang.Exception
serviceCategory
in interface dkService
java.lang.Exception
- when error occurspublic java.lang.String userName() throws java.lang.Exception
userName
in interface dkService
java.lang.Exception
- when error occurspublic DKHandle connection() throws java.lang.Exception
connection
in interface dkService
java.lang.Exception
- when error occurspublic boolean isConnected() throws java.lang.Exception
isConnected
in interface dkService
java.lang.Exception
- when error occurspublic void setServiceName(java.lang.String service_name) throws java.lang.Exception
setServiceName
in interface dkService
new
- value for the service name.java.lang.Exception
- when error occurspublic dkDatastore getDatastore() throws DKException, java.lang.Exception
DKException
- when error occursjava.lang.Exception
- when error occurspublic void setDatastore(dkDatastore ds) throws DKException, java.lang.Exception
ds
- reference to the datastore that will be associated with this document routing service . The parameter should be an instance of DKDatastoreICM.DKException
- when error occursjava.lang.Exception
- when error occurspublic DKDocRoutingServiceMgmtICM getDocRoutingServiceMgmt() throws DKException, java.lang.Exception
The following code assumes docSv is an existing DKDocRoutingServiceMgmt object.
DKDocRoutingServiceMgmtICM docMgmt = docSv.getDocRoutingServiceMgmt();
DKException
- when error occursjava.lang.Exception
- when error occurspublic java.lang.String startProcess(java.lang.String processName, java.lang.String pidString, int priority, java.lang.String owner) throws DKException, java.lang.Exception
The following code assumes docSv is an existing DKDocRoutingServiceICM object. "Process1" is the name of an existing process that is to be started, "pidString1" is an item PID, prority is 1 and owner of the process is "ICMADMIN".
String wpPidString = docSv.startProcess("Process1", "pidString1", 1, "ICMADMIN");
processName
- the name of the process to be startedpidString
- the persistent identifier (pid) string of the item to be routedpriority
- of the work package to be createdowner
- of the work package to be createdDKException
- when error occursjava.lang.Exception
- when error occurspublic java.lang.String startProcess(java.lang.String processName, java.lang.String pidString, int priority, java.lang.String owner, dkCollection container_data) throws DKException, java.lang.Exception
The following code assumes docSv is an existing DKDocRoutingServiceICM object. "Process1" is the name of an existing process that is to be started, "pidString1" is an item persistent identifier (PID), prority is 1 and owner of the process is "ICMADMIN".
String wpPidString = docSv.startProcess("Process1", "pidString1", 1, "ICMADMIN");
processName
- the name the process to be startedpidString
- the persistent identifier (pid) string of the item to be routedpriority
- of the work package to be createdowner
- of the work package to be createdcontainer_data
- of the work package to be createdDKException
- when error occursjava.lang.Exception
- when error occurspublic void terminateProcess(java.lang.String pidString) throws DKException, java.lang.Exception
The following code assumes docSv is an existing DKDocRoutingServiceICM object. "wpPidString1" is the PID of the workpackage to be moved out of the routing process.
docSv.terminateProcess("wpPidString1");
pidString
- the persistent identifier (pid) of the work package to be removed from the document routing processDKException
- when error occursjava.lang.Exception
- when error occurspublic java.lang.String continueProcess(java.lang.String pidString, java.lang.String selection, java.lang.String owner) throws DKException, java.lang.Exception
The following code assumes docSv is an existing DKDocRoutingServiceICM object. "pidString1" is the pid string of the work package to be routed, "Continue" is a selection name from the current node where the work package resides. "ICMADMIN" is the new owner of of this work package.
String wpPidString = docSv.continueProcess("pidString1", "Continue", "ICMADMIN");
pidString
- the pid string of the work package to be routedselection
- value indicating the branch this work package should take out of the current work nodeowner
- the new owner of this work packageDKException
- when error occursjava.lang.Exception
- when error occurspublic java.lang.String continueProcess(java.lang.String pidString, java.lang.String selection, java.lang.String owner, dkCollection container_data) throws DKException, java.lang.Exception
The following code assumes docSv is an existing DKDocRoutingServiceICM object. "pidString1" is the pid string of the work package to be routed, "Continue" is a selection name from the current node where the work package resides. "ICMADMIN" is the new owner of of this work package.
String wpPidString = docSv.continueProcess("pidString1", "Continue", "ICMADMIN");
pidString
- the pid string of the work package to be routedselection
- value indicating the branch this work package should take out of the current work node.owner
- the new owner of this work packagecontainer_data
- the new container data associated with this work pacakgeDKException
- when error occursjava.lang.Exception
- when error occurspublic void suspendProcess(java.lang.String pidString, int duration, dkCollection resume_list) throws DKException, java.lang.Exception
pidString
- the pid of the work package whose associated process is to be suspendedduration
- the duration that this work package will be suspendedresume_list
- the resume list for which this work package is waiting to resume again.DKException
- when error occursjava.lang.Exception
- when error occurspublic void resumeProcess(java.lang.String pidString) throws DKException, java.lang.Exception
pidString
- the pid of the work package whose associated process is to be removedDKException
- when error occursjava.lang.Exception
- when error occurspublic DKWorkPackageICM getNextWorkPackage(java.lang.String worklist_name, java.lang.String owner) throws DKException, java.lang.Exception
worklist_name
- the name of the work list for which the work package is to be retrievedowner
- the owner of the work package to be retrieved. Owner may be left unspecifiedDKException
- when error occursjava.lang.Exception
- when error occurspublic java.lang.String getNextWorkPackagePidString(java.lang.String worklist_name, java.lang.String owner) throws DKException, java.lang.Exception
worklist_name
- the work list name for which the work package PID string is to be retrieved.owner
- the owner of the work package.If not specified, the PID string for the next work package sequentially is retrieved.DKException
- when error occursjava.lang.Exception
- when error occurspublic boolean checkOutItemInWorkPackage(java.lang.String workpackage_pid) throws DKException, java.lang.Exception
workpackage_pid
- persistent identifier (pid) whose associated item is to be checked out.DKException
- when error occursjava.lang.Exception
- when error occurspublic int getCount(java.lang.String worklist_name, java.lang.String owner) throws DKException, java.lang.Exception
worklist_name
- name of work listowner
- the owner of the work package for which work package count is to be retrieved.DKException
- when error occursjava.lang.Exception
- when error occurspublic java.lang.String[] listWorkPackagePidStrings(java.lang.String worklist_name, java.lang.String owner) throws DKException, java.lang.Exception
worklist_name
- name of the work list for which work packages PID strings are to be retrieved.owner
- the owner of the work packageDKException
- when error occursjava.lang.Exception
- when error occurspublic dkCollection listWorkPackages(java.lang.String worklist_name, java.lang.String owner) throws DKException, java.lang.Exception
worklist_name
- name of the work list for which work packages are to be retrieved.owner
- the owner of the work packages to be retrieved from the given work listDKException
- when error occursjava.lang.Exception
- when error occurspublic DKWorkPackageICM retrieveWorkPackage(java.lang.String pidString, boolean checkOut) throws DKException, java.lang.Exception
pidString
- the pidString of the work package whose definition is to be retrieved.checkOut
- flat that indicates whether this work package is to be checked out or not.DKException
- when error occursjava.lang.Exception
- when error occurspublic dkCollection listWorkPackagesWithItem(java.lang.String item_pid) throws DKException, java.lang.Exception
item_pid
- the pidString of the item whose associated work packages are to be retrieved.DKException
- when error occursjava.lang.Exception
- when error occurspublic java.lang.String[] listWorkPackagePidStringsWithItem(java.lang.String item_pid) throws DKException, java.lang.Exception
item_pid
- the pidString of the item whose associated work packages are to be retrieved.DKException
- when error occursjava.lang.Exception
- when error occurspublic int getWorkPackagePriority(java.lang.String workpackage_pid) throws DKException, java.lang.Exception
workpackage_pid
- the pidString of the work package whose priority is to be retrieved.DKException
- when error occursjava.lang.Exception
- when error occurspublic void setWorkPackagePriority(java.lang.String workpackage_pid, int priority) throws DKException, java.lang.Exception
workpackage_pid
- the pidString of the work package whose priority is to be set.priority
- the new priority for the specified work packageDKException
- when error occursjava.lang.Exception
- when error occurspublic java.lang.String getWorkPackageOwner(java.lang.String workpackage_pid) throws DKException, java.lang.Exception
workpackage_pid
- the pidString of the work package whose owner is to be retrieved.DKException
- when error occursjava.lang.Exception
- when error occurspublic void setWorkPackageOwner(java.lang.String workpackage_pid, java.lang.String owner) throws DKException, java.lang.Exception
workpackage_pid
- the pid string of the work package whose owner is to be set.owner
- the new owner of the work packageDKException
- when error occursjava.lang.Exception
- when error occurspublic dkCollection getWorkPackageContainerData(java.lang.String workpackage_pid) throws DKException, java.lang.Exception
workpackage_pid
- the pidString of the work package whose container data is to be retrieved.DKException
- when error occursjava.lang.Exception
- when error occurspublic void setWorkPackageContainerData(java.lang.String workpackage_pid, dkCollection container_data) throws DKException, java.lang.Exception
workpackage_pid
- the pid string of the work package whose container data is to be set.container_data
- the new collection of DKNVPair objects, each of which contains a container data name and the
corresponding container data value for the specified work packageDKException
- when error occursjava.lang.Exception
- when error occurs
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |