Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKWorkPackageICM

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

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

The DKWorkPackageICM class provides a work package definition in Content Manager. When a process instance is started, a work package is created. The work package is the routing element and contains the attributes of the work item that is to be routed via the process. The attributes of the work package consist of the item PID (i.e., Persistent ID of an item), priority, owner etc. Since collection points are special types of work nodes, a work package behaves differently at a collection point. A work package at a collection point node will continue on to the next work node in the process only when the specified number of items of a specified item type exist in the specified folder. Until this condition is met, the process is considered to be "suspended" at the collection point. The number of items and the specified item type associated with a collection point is specified (usually via the system administration client) using a collection resume list entry object.

See Also:
Serialized Form

Constructor Summary
DKWorkPackageICM()
          Default Constructor for the work package object.
 
Method Summary
 dkCollection getContainerData()
          Retrieves the container data collection for this work package.
 int getInstance()
          Retrieves the instance for this work package.
 java.lang.String getItemPidString()
          Retrieves the persistent identifier (pid) string for the item associated with this work package.
 int getNotifyState()
          Retrieves the notify state for this work package.
 DKTimestamp getNotifyTime()
          Retrieves the value for the time at which this work package was put into the notify state.
 java.lang.String getOwner()
          Retrieves the owner for this work package.
 java.lang.String getPidString()
          Retrieves the persistent identifier (pid) string for this work package.
 int getPriority()
          Retrieves the priority for this work package.
 java.lang.String getProcessName()
          Retrieves the name of the process with which this work package is associated.
 dkCollection getResumeList()
          Retrieves the resume list associated with this work package.
 DKTimestamp getResumeTime()
          Retrieves the time at which this work package was moved to the resume state.
 int getSuspendState()
          Retrieves the suspend state for this work package.
 DKTimestamp getTimeLastMoved()
          Retrieves the time at which this work package was last moved.
 java.lang.String getUserLastMoved()
          Retrieves the name of the user who last moved this work package.
 java.lang.String getWorkNodeName()
          Retrieves the name of the work node at which this work package is currently located
 void setContainerData(dkCollection container_data)
          Sets the container data associated with this work package .
 void setInstance(int instance)
          Sets the instance for this work package.
 void setItemPidString(java.lang.String itemPidString)
          Sets the persistent identifier (pid) string for the item associated with this work package.
 void setNotifyState(int notifyState)
          Sets the notify state of this work package.
 void setNotifyTime(DKTimestamp notifyTime)
          Sets the time at which this work package was put in the notify state
 void setOwner(java.lang.String owner)
          Sets the owner for this work package
 void setPidString(java.lang.String pidString)
          Sets the persistent identifer (pid) string for this work package.
 void setPriority(int priority)
          Sets the priority for this work package.
 void setProcessName(java.lang.String process)
          Sets the name of the process with which this work package is associated
 void setResumeList(dkCollection resumeList)
          Sets the resume list associated with this work package.
 void setResumeTime(DKTimestamp resumeTime)
          Sets the time at which this work package was moved to the resume state.
 void setSuspendState(int suspendState)
          Sets the suspend state for this work package.
 void setTimeLastMoved(DKTimestamp lastMovedTime)
          Sets the time at which this work package was last moved.
 void setUserLastMoved(java.lang.String user)
          Sets the name of the user who last moved this work package.
 void setWorkNodeName(java.lang.String workNodeName)
          Sets the the name of the work node at which this work package is currently located.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKWorkPackageICM

public DKWorkPackageICM()
Default Constructor for the work package object. Constructs and initialize a work package instance.

  DKWorkPackageICM wp = new DKWorkPackageICM();
  
Method Detail

setPidString

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

getPidString

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

getInstance

public int getInstance()
Retrieves the instance for this work package.
Returns:
the instance for this work package

setInstance

public void setInstance(int instance)
Sets the instance for this work package.
Parameters:
instance - the instance for this work package.

getPriority

public int getPriority()
Retrieves the priority for this work package. The value for the priority is not enforced by Content Manager. It is just an application-specific value that is left to the user to do with as they choose
Returns:
the priority for this work package

setPriority

public void setPriority(int priority)
Sets the priority for this work package. The value for the priority is not enforced by Content Manager. It is just an application-specific value that is left to the user to do with as they choose
Parameters:
priority - the new priority value for this work package

getUserLastMoved

public java.lang.String getUserLastMoved()
Retrieves the name of the user who last moved this work package.
Returns:
the name of the user who last moved this work package

setUserLastMoved

public void setUserLastMoved(java.lang.String user)
Sets the name of the user who last moved this work package.
Parameters:
user - the name of the user who last moved this work package

getTimeLastMoved

public DKTimestamp getTimeLastMoved()
Retrieves the time at which this work package was last moved.
Returns:
the time at which this work package was last moved

setTimeLastMoved

public void setTimeLastMoved(DKTimestamp lastMovedTime)
Sets the time at which this work package was last moved.
Parameters:
lastMovedTime - the time at which this work package was last moved

getSuspendState

public int getSuspendState()
Retrieves the suspend state for this work package.
Returns:
the suspend state of this work package. If the return value is 0, the package is not suspended. If the return value is 1, the package is suspended.

setSuspendState

public void setSuspendState(int suspendState)
Sets the suspend state for this work package.
Parameters:
suspendState - for this work package. If the return value is 0, the package is not suspended. If the return value is 1, the package is suspended.

getNotifyState

public int getNotifyState()
Retrieves the notify state for this work package.
Returns:
the notify state of this work package. If the return value is 0, the package is not in the notify state. If the return value is 1, the package is in the notify state.

setNotifyState

public void setNotifyState(int notifyState)
Sets the notify state of this work package.
Parameters:
notifyState - of this work package. If the return value is 0, the package is not in the notify state. If the return value is 1, the package is in the notify state.

getNotifyTime

public DKTimestamp getNotifyTime()
Retrieves the value for the time at which this work package was put into the notify state.
Returns:
the notify time of this work package

setNotifyTime

public void setNotifyTime(DKTimestamp notifyTime)
Sets the time at which this work package was put in the notify state
Parameters:
notifyTime - the notifyTime for this work package

getResumeTime

public DKTimestamp getResumeTime()
Retrieves the time at which this work package was moved to the resume state.
Returns:
the resume time of this work package

setResumeTime

public void setResumeTime(DKTimestamp resumeTime)
Sets the time at which this work package was moved to the resume state.
Parameters:
resumeTime - the resumeTime for this work package

getResumeList

public dkCollection getResumeList()
                           throws DKException,
                                  java.lang.Exception
Retrieves the resume list associated with this work package.
Returns:
the collection of resume list entries for this work package as instances of DKResumeListEntryICM

setResumeList

public void setResumeList(dkCollection resumeList)
Sets the resume list associated with this work package.
Parameters:
resumeList - the collection of resume list entries for this work package as instances of DKResumeListEntryICM

getItemPidString

public java.lang.String getItemPidString()
Retrieves the persistent identifier (pid) string for the item associated with this work package.
Returns:
the pid string of the item associated with this work package

setItemPidString

public void setItemPidString(java.lang.String itemPidString)
Sets the persistent identifier (pid) string for the item associated with this work package.
Parameters:
itemPidString - the pid string of theitem associated with this work package

getProcessName

public java.lang.String getProcessName()
Retrieves the name of the process with which this work package is associated.
Returns:
the name of the process with which this work package is associated

setProcessName

public void setProcessName(java.lang.String process)
Sets the name of the process with which this work package is associated
Parameters:
process - the name of the process with which this work package is associated.

getWorkNodeName

public java.lang.String getWorkNodeName()
Retrieves the name of the work node at which this work package is currently located
Returns:
the name of the work node where the work package is currently located

setWorkNodeName

public void setWorkNodeName(java.lang.String workNodeName)
Sets the the name of the work node at which this work package is currently located.
Parameters:
workNodeName - the name of the work node where the work package is currently located.

getOwner

public java.lang.String getOwner()
Retrieves the owner for this work package.
Returns:
the owner for this work package.

setOwner

public void setOwner(java.lang.String owner)
Sets the owner for this work package
Parameters:
owner - the owner for this work package

setContainerData

public void setContainerData(dkCollection container_data)
Sets the container data associated with this work package .
Parameters:
container_data - a collection of name-value pairs as instances of DKNVPair objects, each of which represents a container data name and the corresponding container data value.

getContainerData

public dkCollection getContainerData()
Retrieves the container data collection for this work package.
Returns:
a collection of name-value pairs as instances of DKNVPair objects, each of which represents a container data name and the corresponding container data value.

EIP Java APIs

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