com.ibm.rpm.workflow.containers
RunningWorkflowProcess

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.workflow.containers.RunningWorkflowProcess

RunningWorkflowProcess
Extends: com.ibm.rpm.framework.RPMObject
Child objects: None

Related scope: com.ibm.rpm.workflow.scope.RunningWorkflowProcessScope

A RunningWorkflowProcess object is used to depict the running processes for a WorkElement, GenericDocument, or an AbstractScope.

Supported API Calls: Primary key: The following fields are required when using the loadFromID and loadArrayFromID methods:

ID

Field Summary
xsd:string currentStep
    The current step of the WorkflowProcess for the associated container. Once WorkflowDesign is implemented in the API, this will become a WorkflowStep container.
xsd:dateTime startDate
    The start date of the WorkflowProcess for the associated container.
WorkflowState state
    The state of the WorkflowProcess for the associated container.
WorkflowProcess workflowProcess
    The WorkflowProcess running on the associated container.
xsd:string workflowProcessName
    The name of the associated WorkflowProcess. This is displayed here in case a running workflow is deleted (null workflowProcess).

Inherited Field Summary
xsd:string contextName
   The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.
xsd:boolean deleted
   If the value of this field is set to true, then the RPMObject will be deleted when performing a save.
xsd:string ID
   The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.
RPMObject parent
   The parent of the RPMObject.

Field Detail

currentStep


xsd:string  currentStep
The current step of the WorkflowProcess for the associated container. Once WorkflowDesign is implemented in the API, this will become a WorkflowStep container.

Read-only behavior: The value of this field is read only.


startDate


xsd:dateTime  startDate
The start date of the WorkflowProcess for the associated container.

Read-only behavior: The value of this field is read only.


state


WorkflowState state
The state of the WorkflowProcess for the associated container.

Read-only behavior: The value of this field is read only.

Relationship: This field is a reference relationship.


workflowProcess


WorkflowProcess workflowProcess
The WorkflowProcess running on the associated container.

Read-only behavior: The value of this field is read only.

Relationship: This field is a reference relationship.


workflowProcessName


xsd:string  workflowProcessName
The name of the associated WorkflowProcess. This is displayed here in case a running workflow is deleted (null workflowProcess).

Read-only behavior: The value of this field is read only.


Inherited Field Detail

contextName


xsd:string  contextName
The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


deleted


xsd:boolean  deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


ID


xsd:string  ID
The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.

Read-only behavior: The value of this field is read only.


parent


RPMObject parent
The parent of the RPMObject.

Scoping: This field will be used by the API if the scope field parent is enabled.

Read-only behavior: The value of this field is read only after the object was created.

Relationship: This field is a reference relationship.

X-Path availability: This field doesn't support X-Path queries.