|
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.DKWorkFlowFed
An object oriented representation of the workflow in the workflow engine. The workpacket name is used to uniquely identify a workflow.
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 | |
DKWorkFlowFed(dkWorkFlowServiceFed service)
Constructs a DKWorkFlowFed object with the specified workflow service. |
|
DKWorkFlowFed(dkWorkFlowServiceFed service,
java.lang.String name)
Constructs a DKWorkFlowFed object with the specified workflow service and a workflow name. |
Method Summary | |
void |
add(java.lang.String workflow_template)
Adds a workflow in the system. |
void |
del()
Deletes the workflow. |
DKTimestamp |
endTime()
Returns the end time of the workflow. |
java.lang.String |
getDescription()
Returns the description of the workflow. |
java.lang.String |
getName()
Returns the name the workflow. |
DKWorkFlowContainerFed |
inContainer()
Returns a DKWorkFlowContainerFed object associated with the In Container of this workflow. |
DKTimestamp |
modifiedTime()
Returns the last modification time of the workflow. |
DKTimestamp |
notificationTime()
Returns the notification time. |
void |
resume()
Resuems the suspended workflow. |
void |
resumeDeep()
Resuems the suspended workflow and its sub-workflows. |
void |
retrieve()
Retrieves and refreshes the information of the workflow. |
void |
setDescription(java.lang.String description)
Sets the description of the workflow. |
void |
setName(java.lang.String name)
Sets the name of the workflow. |
void |
start(DKWorkFlowContainerFed container)
Starts the workflow with an input container. |
DKTimestamp |
startTime()
Returns the start time of the workflow. |
int |
state()
Returns the state of the workflow. |
DKTimestamp |
stateChangeTime()
Returns the state change time of the workflow. |
void |
suspend(DKTimestamp suspension_time)
Suspends the workflow with a specified time. |
void |
suspendDeep(DKTimestamp suspension_time)
Suspends the workflow and its sub-workflows with a specified time. |
DKTimestamp |
suspensionTime()
Returns the suspension time of the workflow. |
void |
terminate()
Terminates the workflow. |
void |
update()
Updates the workflow. |
java.lang.String |
workFlowTemplateName()
Returns the name of the workflow template that is associated with the workflow. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKWorkFlowFed(dkWorkFlowServiceFed service) throws DKException, java.lang.Exception
service
- DKWorkFlowServiceFed object.public DKWorkFlowFed(dkWorkFlowServiceFed service, java.lang.String name) throws DKException, java.lang.Exception
sercvive
- DKWorkFlowServiceFed object.name
- name of a workflow.Method Detail |
public java.lang.String getName() throws DKException, java.lang.Exception
public void setName(java.lang.String name) throws DKException, java.lang.Exception
name
- name of the workflow.public java.lang.String getDescription() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowFed object is not retrieved.public void setDescription(java.lang.String description) throws DKException, java.lang.Exception
description
- description of the workflowpublic java.lang.String workFlowTemplateName() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowFed object is not retrieved.public DKTimestamp modifiedTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowFed object is not retrieved.public DKTimestamp notificationTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowFed object is not retrieved.public DKTimestamp stateChangeTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowFed object is not retrieved.public DKTimestamp startTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowFed object is not retrieved.public DKTimestamp endTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowFed object is not retrieved.public DKTimestamp suspensionTime() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowFed object is not retrieved.public int state() throws DKException, java.lang.Exception
DKUsageError
- if the DKWorkFlowFed object is not retrieved.public DKWorkFlowContainerFed inContainer() throws DKException, java.lang.Exception
The inContainer method is called to retrieve the container content of a workflow. The following code assumes WF is a retrieved DKWorkFlowFed object.
DKWorkFlowContainerFed con = WF.inContainer();
DKUsageError
- if the DKWorkFlowFed object is not retrieved.public void start(DKWorkFlowContainerFed container) throws DKException, java.lang.Exception
The following code assumes WF is a retrieved DKWorkFlowFed object. An input container is retrieved first. A valid PID string pid is specified, which is a persistent ID of a document. The priority is set to 100. The input container is passed to the start method to start a workflow instance.
DKWorkFlowContainerFed con = WF.inContainer(); con.retrieve(); con.setPersistentID(pid); con.setPriority(100); con.update(); WF.start(con);
container
- DKWorkFlowContainerFed object.DKUsageError
- if the DKWorkFlowFed object is not retrieved, or
the start operation fails.public void terminate() throws DKException, java.lang.Exception
The following code assumes WF is a retrieved DKWorkFlowFed object.
WF.terminate();
DKUsageError
- if the DKWorkFlowFed object is not retrieved,
the workflow is in an incorrect state, or
the terminate operation fails.public void suspend(DKTimestamp suspension_time) throws DKException, java.lang.Exception
The following code assumes WF is a retrieved DKWorkFlowFed object.
if (WF.state() == DKConstantFed.DK_FED_FMC_PS_RUNNING) { DKTimestamp suspension = null; WF.suspend(suspension); }
suspension_time
- suspension time.DKUsageError
- if the DKWorkFlowFed object is not retrieved,
the workflow is in an incorrect state, or
the suspend operation fails.public void suspendDeep(DKTimestamp suspension_time) throws DKException, java.lang.Exception
The following code assumes WF is a retrieved DKWorkFlowFed object.
if (WF.state() == DKConstantFed.DK_FED_FMC_PS_RUNNING) { DKTimestamp suspension = null; WF.suspendDeep(suspension); }
suspension_time
- suspension time.DKUsageError
- if the DKWorkFlowFed object is not retrieved,
the workflow is in an incorrect state, or
the suspend operation fails.public void resume() throws DKException, java.lang.Exception
The following code assumes WF is a retrieved DKWorkFlowFed object.
WF.resume();
DKUsageError
- if the DKWorkFlowFed object is not retrieved,
the workflow is in an incorrect state, or
the resume operation fails.public void resumeDeep() throws DKException, java.lang.Exception
The following code assumes WF is a retrieved DKWorkFlowFed object.
WF.resumeDeep();
DKUsageError
- if the DKWorkFlowFed object is not retrieved,
the workflow is in an incorrect state, or
the resume operation fails.public void add(java.lang.String workflow_template) throws DKException, java.lang.Exception
The following code assumes svWF is an existing DKWorkFlowServiceFed object. WF is created as a new DKWorkFlowFed object. The setName method defines the name of the workflow such as "Claim001". The add method will create a workflow instance with the specified name "Claim001" based on the workflow template such as "ClaimProcess". The name of the workflow must be unique. If the name of the workflow is not specified, a unique workflow name will be generated with the workflow template name as the prefix.
DKWorkFlowFed WF = new DKWorkFlowFed(svWF); WF.setName("Claim001"); WF.add("ClaimProcess");
workflow_template
- name of a workflow template.DKUsageError
- if the add operation fails.public void update() throws DKException, java.lang.Exception
The following code assumes WF is a retrieved DKWorkFlowFed object.
WF.setDescription("Updated description"); WF.update();
DKUsageError
- if the DKWorkFlowFed object is not retrieved, or
the update operation fails.public void del() throws DKException, java.lang.Exception
The following code assumes WF is a retrieved DKWorkFlowFed object.
WF.del();
DKUsageError
- if the DKWorkFlowFed object is not retrieved,
the workflow is in an incorrect state, or
the delete operation fails.public void retrieve() throws DKException, java.lang.Exception
The following code assumes WF is a DKWorkFlowFed object.
WF.retrieve();
DKUsageError
- if the DKWorkFlowFed object cannot be retrieved.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |