Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKProcessICM

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

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

The DKProcessICM class represents a process or a workflow instance in Content Manager. A process is series of steps defined by an administrator through which a work package containing an item is routed.A process consists of two or more work nodes. The first node of the process must be a work node with the defined name DK_ICM_DR_START_NODE. The last node of the process must be a work node with the defined name DK_ICM_DR_END_NODE. The process can contain multiple nodes between the start node and the end node with multiple branches between any of the intermediate nodes.

See Also:
DKRouteListEntryICM, DKDocRoutingServiceICM, DKWorkNodeICM, DKWorkListICM, Serialized Form

Constructor Summary
DKProcessICM()
          Default constructor for the process object.
 
Method Summary
 java.lang.String getACLName()
          Retrieves the name of the ACL associated with this process
 java.lang.String getDescription()
          Retrieves the description for this process
 DKProcessExtICM getExtension()
          Retrieves the extension object associated with this process object
 java.lang.String getName()
          Retrieves the name for this process
 java.lang.String getPidString()
          Retrieves the persistent identifier (pid) for this process
 dkCollection getRoute()
          Retrieves the route for this process.
 void setACLName(java.lang.String aclName)
          Sets the name of the ACL associated with this process
 void setDescription(java.lang.String desc)
          Sets the description for this process
 void setExtension(DKProcessExtICM ext)
          Sets the extension for this process object
 void setName(java.lang.String name)
          Sets the name for this process
 void setPidString(java.lang.String pidString)
          Sets the pid for this process
 void setRoute(dkCollection coll)
          Sets the route for this process.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKProcessICM

public DKProcessICM()
Default constructor for the process object. Constructs and initializes a process instance.
  DKProcessICM process = new DKProcessICM();
  
Method Detail

getName

public java.lang.String getName()
Retrieves the name for this process
Returns:
the name of this process as a string

setName

public void setName(java.lang.String name)
Sets the name for this process
Parameters:
name - new name for this process

getDescription

public java.lang.String getDescription()
Retrieves the description for this process
Returns:
the description of this process as a string

setDescription

public void setDescription(java.lang.String desc)
Sets the description for this process
Parameters:
desc - the new description for this process

setPidString

public void setPidString(java.lang.String pidString)
Sets the pid for this process
Parameters:
the - new pid for this process

getPidString

public java.lang.String getPidString()
Retrieves the persistent identifier (pid) for this process
Returns:
the pid for this process as a string

getACLName

public java.lang.String getACLName()
Retrieves the name of the ACL associated with this process
Returns:
the name of the ACL associated with this process as a string

setACLName

public void setACLName(java.lang.String aclName)
Sets the name of the ACL associated with this process
Parameters:
aclName - the name of the new ACL associated with this process

getRoute

public dkCollection getRoute()
                      throws DKException
Retrieves the route for this process. The route is returned as a collection of route list entries. Each route list entry defines paths between a pair of work nodes. The process traverses the route beginning at the start node and terminating at the end node
Returns:
the route for this process as a collection of route list entries. Each route list entry is an instance of DKRouteListEntryICM
Throws:
DKException - when error occurs

setRoute

public void setRoute(dkCollection coll)
              throws DKException
Sets the route for this process. The route for the process is specified as a collection of route list entries.
Parameters:
coll - the collection of route list entries for this process as instances of DKRouteListEntryICM
Throws:
DKException - when error occurs

setExtension

public void setExtension(DKProcessExtICM ext)
Sets the extension for this process object
Parameters:
ext - a process extension object as an instance of DKProcessExtICM to be associated with this process object. DKProcessExtICM contains a collection of DKNVPair objects, each of which has name as a user-defined attribute name and a value as the corresponding user-defined attribute value for this process object.
See Also:
DKProcessExtICM

getExtension

public DKProcessExtICM getExtension()
Retrieves the extension object associated with this process object
Returns:
the process extension object as an instance of DKProcessExtICM associated with this process, A DKProcessExtICM object contains a collection of DKNVPair objects, each of which has a name as a user-defined attribute name and a value as the corresponding user-defined attribute value for this process object.
See Also:
DKProcessExtICM

EIP Java APIs

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