|
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.DKWorkPackageICM
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.
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 |
public DKWorkPackageICM()
DKWorkPackageICM wp = new DKWorkPackageICM();
Method Detail |
public void setPidString(java.lang.String pidString)
pidString
- the pid for this work package.public java.lang.String getPidString()
public int getInstance()
public void setInstance(int instance)
instance
- the instance for this work package.public int getPriority()
public void setPriority(int priority)
priority
- the new priority value for this work packagepublic java.lang.String getUserLastMoved()
public void setUserLastMoved(java.lang.String user)
user
- the name of the user who last moved this work packagepublic DKTimestamp getTimeLastMoved()
public void setTimeLastMoved(DKTimestamp lastMovedTime)
lastMovedTime
- the time at which this work package was last movedpublic int getSuspendState()
public void setSuspendState(int suspendState)
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.public int getNotifyState()
public void setNotifyState(int notifyState)
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.public DKTimestamp getNotifyTime()
public void setNotifyTime(DKTimestamp notifyTime)
notifyTime
- the notifyTime for this work packagepublic DKTimestamp getResumeTime()
public void setResumeTime(DKTimestamp resumeTime)
resumeTime
- the resumeTime for this work packagepublic dkCollection getResumeList() throws DKException, java.lang.Exception
public void setResumeList(dkCollection resumeList)
resumeList
- the collection of resume list entries for this work package as instances of DKResumeListEntryICMpublic java.lang.String getItemPidString()
public void setItemPidString(java.lang.String itemPidString)
itemPidString
- the pid string of theitem associated with this work packagepublic java.lang.String getProcessName()
public void setProcessName(java.lang.String process)
process
- the name of the process with which this work package is associated.public java.lang.String getWorkNodeName()
public void setWorkNodeName(java.lang.String workNodeName)
workNodeName
- the name of the work node where the work package is currently located.public java.lang.String getOwner()
public void setOwner(java.lang.String owner)
owner
- the owner for this work packagepublic void setContainerData(dkCollection container_data)
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.public dkCollection getContainerData()
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |