Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkNodeICM

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

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

The DKWorkNodeICM class represents a work node in Content Manager. A document routing process consists of work nodes and collection points . Each work node and collection point in the process is a separate step in the process. A collection point is a special work node which has a resume list associated with it. A resume list is a list of documents required for particular folders which are routed to this worknode. The required documents must all arrive at this work node and be added to the particular folder before this folder can automatically move to the next work node in the document routing process. Work nodes are usually created by a system administrator using the system administration client. A document routing process can also be set up to perform branching. The system administrator defines the branches in a process by defining multiple alternate routes from one work node in the process to the next. The branch taken from a specific work node to the next is determined by the user at process execution time. The user may choose from a list of possible selections which the system administrator defines. When defining a work node, a server exit may also be defined. Server exits may be defined for entering a work node, leaving a work node, and when the overload limit is reached.

See Also:
DKWorkListICM, DKProcessICM, DKCollectionResumeListEntryICM, Serialized Form

Constructor Summary
DKWorkNodeICM()
          Default constructor for the work node class.
 
Method Summary
 java.lang.String getACLName()
          Retrieves the name of the access control list (ACL) associated with this work node object.
 dkCollection getCollectionResumeList()
          Retrieves the resume list associated with this work node object
 java.lang.String getDescription()
          Retrieves the description for this work node object.
 java.lang.String getEnterUserDll()
          Retrieves the name of the DLL containing the user-defined function that will be called when the work package enters this work node
 java.lang.String getEnterUserFunction()
          Retrieves the name of the user-defined function that will be called when a work package enters this work node
 DKWorkNodeExtICM getExtension()
          Retrieves the extension object associated with this work node object
 java.lang.String getLeaveUserDll()
          Retrieves the name of the DLL containing the user-defined function that will be called when a work package leaves this work node
 java.lang.String getLeaveUserFunction()
          Retrieves the name of the user-defined function that will be called when a work package leaves this work node
 java.lang.String getName()
          Retrieves the name for this work node object.
 int getOverloadLimit()
          Retrieves the maximum number of work packages (overload limit) that can be at this work node at any given time.
 java.lang.String getOverloadUserDll()
          Retrieves the name of the user-defined DLL that contains the overload limit user-defined function for this work node
 java.lang.String getOverloadUserFunction()
          Retrieves the name of the user defined function that will be called when the number of work packages at this work node exceeds the overload limit.
 java.lang.String getPidString()
          Retrieves the persistent identifier (pid) string for this work node
 int getTimeLimit()
          Retrieves the maximum amount of time (time limit) that a work package can stay at this work node.
 int getType()
          Retrieves the work node type.
 void setACLName(java.lang.String aclName)
          Sets the name of the access control list (ACL) associated with this work node object.
 void setCollectionResumeList(dkCollection coll)
          Sets the resume list for this work node object
 void setDescription(java.lang.String desc)
          Sets the description for this work node object.
 void setEnterUserDll(java.lang.String enterUserDll)
          Sets the name of the DLL containing the user-defined function that will be called when a work package enters this work node
 void setEnterUserFunction(java.lang.String enterUserFunction)
          Sets the name of the user-defined function that will be called when a work package enters this work node
 void setExtension(DKWorkNodeExtICM ext)
          Sets the extension object associated with his work node object
 void setLeaveUserDll(java.lang.String leaveUserDll)
          Sets the name of the DLL containing the user-defined function that will be called when a work package leaves this work node
 void setLeaveUserFunction(java.lang.String leaveUserFunction)
          Sets the name of the user-defined function that will be called when a work package leaves this work node
 void setName(java.lang.String name)
          Sets the name for this work node object.
 void setOverloadLimit(int overloadLimit)
          Sets the value for the maximum number of work packages (overload limit) that can be at this work node at any given time.
 void setOverloadUserDll(java.lang.String overloadUserDll)
          Sets the name of the DLL that contains the overload user-defined function for this work node.
 void setOverloadUserFunction(java.lang.String overloadUserFunction)
          Sets the name of the user defined function that will be called when the number of work packages at this node exceeds the overload limit.
 void setPidString(java.lang.String pidString)
          Sets the persistent identifier (pid) string for this work node
 void setTimeLimit(int timeLimit)
          Sets the value for the maximum amount of time (time limit) that a work package can stay at this work node.
 void setType(int type)
          Sets the work node type.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKWorkNodeICM

public DKWorkNodeICM()
Default constructor for the work node class. Constructs and initializes a work node instance.
  DKWorkNodeICM wn = new DKWorkNodeICM();
  
Method Detail

getName

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

setName

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

getDescription

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

setDescription

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

getACLName

public java.lang.String getACLName()
Retrieves the name of the access control list (ACL) associated with this work node object.
Returns:
the name of ACL associated with this work node object

setACLName

public void setACLName(java.lang.String aclName)
Sets the name of the access control list (ACL) associated with this work node object.
Parameters:
aclName - the name of the new ACL associated with this work node object

getType

public int getType()
Retrieves the work node type. A return value of 0 indicates that this work node is a regular work node. A return value of 1 indicates that this work node is a collection point.
Returns:
the type of this work node object

setType

public void setType(int type)
             throws DKException
Sets the work node type. if the parameter value is 0, the work node is set to be a regular work node. If the parameter value is 1, the work node is set to be a collection point
Parameters:
type - the new value for the work node type
Throws:
DKException - when the parameter is not equal to 0 or 1

getTimeLimit

public int getTimeLimit()
Retrieves the maximum amount of time (time limit) that a work package can stay at this work node.
Returns:
the time limit of the work node.

setTimeLimit

public void setTimeLimit(int timeLimit)
Sets the value for the maximum amount of time (time limit) that a work package can stay at this work node.
Parameters:
timeLimit - the new value for the time limit for this work node

getOverloadLimit

public int getOverloadLimit()
Retrieves the maximum number of work packages (overload limit) that can be at this work node at any given time.
Returns:
the overload limit for this work node

setOverloadLimit

public void setOverloadLimit(int overloadLimit)
Sets the value for the maximum number of work packages (overload limit) that can be at this work node at any given time.
Parameters:
overloadLimit - the new value for the overload limit for this work node

getOverloadUserFunction

public java.lang.String getOverloadUserFunction()
Retrieves the name of the user defined function that will be called when the number of work packages at this work node exceeds the overload limit.
Returns:
the name of the user-defined function to be called when the overload limit is exceeded at this work node

setOverloadUserFunction

public void setOverloadUserFunction(java.lang.String overloadUserFunction)
Sets the name of the user defined function that will be called when the number of work packages at this node exceeds the overload limit.
Parameters:
overloadUserFunction - the name of the user-defined function called when the overload limit is exceeded for this work node

getOverloadUserDll

public java.lang.String getOverloadUserDll()
Retrieves the name of the user-defined DLL that contains the overload limit user-defined function for this work node
Returns:
the name of the DLL containing the overload user-defined function for this work node

setOverloadUserDll

public void setOverloadUserDll(java.lang.String overloadUserDll)
Sets the name of the DLL that contains the overload user-defined function for this work node.
Parameters:
overloadUserDll - the name of the DLL containing the overload user-defined function for this work node

getEnterUserFunction

public java.lang.String getEnterUserFunction()
Retrieves the name of the user-defined function that will be called when a work package enters this work node
Returns:
the name of the user-defined function called when a work package enters the work node

setEnterUserFunction

public void setEnterUserFunction(java.lang.String enterUserFunction)
Sets the name of the user-defined function that will be called when a work package enters this work node
Parameters:
userFunction - the name of the user-defined function called when a work package enters this work node

getEnterUserDll

public java.lang.String getEnterUserDll()
Retrieves the name of the DLL containing the user-defined function that will be called when the work package enters this work node
Returns:
the name of the DLL containing the enter user-defined function for this work node

setEnterUserDll

public void setEnterUserDll(java.lang.String enterUserDll)
Sets the name of the DLL containing the user-defined function that will be called when a work package enters this work node
Parameters:
userDll - the name of the DLL containing the enter user-defined function for this work node

getLeaveUserFunction

public java.lang.String getLeaveUserFunction()
Retrieves the name of the user-defined function that will be called when a work package leaves this work node
Returns:
the name of the user-defined function called when a work package enters this work node

setLeaveUserFunction

public void setLeaveUserFunction(java.lang.String leaveUserFunction)
Sets the name of the user-defined function that will be called when a work package leaves this work node
Parameters:
userFunction - the name of the user-defined function called when a work package enters this work node

getLeaveUserDll

public java.lang.String getLeaveUserDll()
Retrieves the name of the DLL containing the user-defined function that will be called when a work package leaves this work node
Returns:
the name of the DLL containing the leave user-defined function for this work node

setLeaveUserDll

public void setLeaveUserDll(java.lang.String leaveUserDll)
Sets the name of the DLL containing the user-defined function that will be called when a work package leaves this work node
Parameters:
userDll - the name of the DLL containing the leave user-defined function for this work node

getCollectionResumeList

public dkCollection getCollectionResumeList()
                                     throws DKException
Retrieves the resume list associated with this work node object
Returns:
a collection of the collection resume list entry objects as instances of DKCollectionResumeListEntryICM
Throws:
DKException - when error occurs

setCollectionResumeList

public void setCollectionResumeList(dkCollection coll)
                             throws DKException
Sets the resume list for this work node object
Parameters:
a - collection of collection resume list entries as instances of DKCollectionResumeListEntryICM
Throws:
DKException - when error occurs

setPidString

public void setPidString(java.lang.String pidString)
Sets the persistent identifier (pid) string for this work node
Parameters:
pidString - the pid string for this work node

getPidString

public java.lang.String getPidString()
Retrieves the persistent identifier (pid) string for this work node
Returns:
the pid string for this work node

setExtension

public void setExtension(DKWorkNodeExtICM ext)
Sets the extension object associated with his work node object
Parameters:
ext - a worknode extension object as an instance of DKWorkNodeExtICM to be associated with this work node object. A DKWorkNodeExtICM contains a collection of name-value pairs as instances of DKNVPair ,each of which has a name as a user-defined attribute name and a value as the corresponding user-defined attribute value for this work node object.
See Also:
DKWorkNodeExtICM

getExtension

public DKWorkNodeExtICM getExtension()
Retrieves the extension object associated with this work node object
Returns:
the work node extension as an instance of DKWorkNodeExtICM associated with this work node. A DKWorkNodeExtICM object contains a collection of name-value pairs as instances 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 work node object.
See Also:
DKWorkNodeExtICM

EIP Java APIs

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