|
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.DKWorkItemFed
An object oriented representation of a workitem in the system. A workitem indicates the current location (i.e., a node) in a workflow when the workitem is retrieved.
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKWorkItemFed(dkWorkFlowServiceFed service,
java.lang.String workflow_name,
java.lang.String name,
java.lang.String owner_name)
Constructs a DKWorkItemFed with the specified workflow service, a workflow name, a node name, and owner name. |
Method Summary | |
void |
cancel()
Cancels the workitem. |
void |
checkIn(DKWorkFlowContainerFed container)
Checks in the workitem and informs the workflow server that user preocessing has finished. |
void |
checkOut()
Checks out a workitem for user processing and changes the state of workitem to DK_FED_FMC_IS_CHECKEDOUT. |
DKTimestamp |
creationTime()
Returns the creation time of the workitem. |
java.lang.String |
description()
Returns the node description. |
DKWorkFlowContainerFed |
inContainer()
Returns a DKWorkFlowContainerFed object associated with the In Container of this workitem. |
DKTimestamp |
modifiedTime()
Returns the last modified time of the workiteem. |
java.lang.String |
name()
Returns the node name. |
DKTimestamp |
notificationTime()
Returns the notification time. |
DKWorkFlowContainerFed |
outContainer()
Returns a DKWorkFlowContainerFed object associated with the Out Container of this workitem. |
java.lang.String |
owner()
Returns the owner of the worktime. |
int |
priority()
Returns the priority of the worktime. |
DKTimestamp |
receivedTime()
Returns the received time of the workitem. |
int |
receiveReason()
Returns the received reason of the workitem. |
void |
retrieve()
Retrieves and refreshes the information of the workitem. |
DKTimestamp |
startTime()
Returns the start time of the worktime. |
int |
state()
Returns the state of the workitem. |
void |
transfer(java.lang.String user_id)
Transfers the workitem to the specified user ID. |
java.lang.String |
workFlowName()
Returns the workflow name. |
java.lang.String |
workFlowTemplateName()
Returns the workflow template name of the workitem. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKWorkItemFed(dkWorkFlowServiceFed service, java.lang.String workflow_name, java.lang.String name, java.lang.String owner_name) throws DKException, java.lang.Exception
service
- DkWorkFlowServiceFed object.workflow_name
- name of a workflow.name
- name of a node.owner_name
- name of the ownerMethod Detail |
public java.lang.String name() throws DKException, java.lang.Exception
public java.lang.String description() throws DKException, java.lang.Exception
public int state() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkItemFed object is not retrieved.public java.lang.String workFlowName() throws DKException, java.lang.Exception
public java.lang.String workFlowTemplateName() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkItemFed object is not retrieved.public int priority() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkItemFed object is not retrieved.public java.lang.String owner() throws DKException, java.lang.Exception
public DKTimestamp startTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkItemFed object is not retrieved.public DKTimestamp creationTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkItemFed object is not retrieved.public DKTimestamp notificationTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkItemFed object is not retrieved.public DKTimestamp modifiedTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkItemFed object is not retrieved.public DKTimestamp receivedTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkItemFed object is not retrieved.public int receiveReason() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkItemFed object is not retrieved.public void retrieve() throws DKException, java.lang.Exception
The following code assumes WI is a DKWorkItemFed object.
WI.retrieve();
DKUsageError
- if the DKWorkItemFed object cannot be retrieved.public void checkIn(DKWorkFlowContainerFed container) throws DKException, java.lang.Exception
The following code assumes WI is a retrieved DKWorkItemFed object.
WI.checkIn();
container
- DKWorkFlowContainerFed object.DKUsageError
- if the DKWorkItemFed object is not retrieved, or
the checkin operation failspublic void checkOut() throws DKException, java.lang.Exception
The following code assumes WI is a retrieved DKWorkItemFed object.
WI.checkOut();
DKUsageError
- if the DKWorkItemFed object is not retrieved, or
the checkout operation fails.public void transfer(java.lang.String user_id) throws DKException, java.lang.Exception
user_id
- user ID.
The following code assumes WI is a retrieved DKWorkItemFed object.
WI.transfer("USERID");
DKUsageError
- if the DKWorkItemFed object is not retrieved,
the transfer operation fails, the workitem is not in the correct state,
or the workflow is not in the correct state.public void cancel() throws DKException, java.lang.Exception
The following code assumes WI is a retrieved DKWorkItemFed object.
WI.cancel();
DKUsageError
- if the DKWorkItemFed object is not retrieved,
the cancel operation fails, the workitem is not in the correct state,
or the workflow is not in the correct state.public DKWorkFlowContainerFed inContainer() throws DKException, java.lang.Exception
The inContainer method is called to view the container content of a workitem. The following code assumes WI is a retrieved DKWorkItemFed object.
DKWorkFlowContainerFed con = WI.inContainer();
DKUsageError
- if the DKWorkItemFed object is not retrieved or
the DKWorkFowContainerFed object cannot be retrieved.public DKWorkFlowContainerFed outContainer() throws DKException, java.lang.Exception
The outContainer method is called to update the container content of a workitem. The following code assumes WI is a retrieved DKWorkItemFed object.
DKWorkFlowContainerFed con = WI.outContainer();
DKUsageError
- if the DKWorkItemFed object is not retrieved or
the DKWorkFowContainerFed object cannot be retrieved.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |