com.ibm.bpe.api
Interface ProcessInstanceData

All Superinterfaces:
java.io.Serializable

public interface ProcessInstanceData
extends java.io.Serializable

Accesses the properties of a process instance.

A process instance comes into existence when a process template is instantiated, for example, by an initiate request. It is started immediately causing its state initially to be set to running. Execution is driven automatically by the process engine.

Since:
6.0 - introduced in 5.0

Field Summary
static java.lang.String COPYRIGHT
           
static int STATE_COMPENSATED
          States that compensation has been finished for the process instance.
static int STATE_COMPENSATING
          States that compensation has been started for the process instance.
static int STATE_COMPENSATION_FAILED
          States that the (sub)proces compensation is failed.
static int STATE_FAILED
          States that the process instance failed to execute.
static int STATE_FAILING
          States that an expected or unexpected exception has been encountered.
static int STATE_FINISHED
          States that the process instance completed successfully.
static int STATE_INDOUBT
          States that the compensation has encounterd a problem.
static int STATE_READY
          For future use.
static int STATE_RUNNING
          States that the process instance is running.
static int STATE_SUSPENDED
          States that the (sub)process instance is supspended
static int STATE_TERMINATED
          States that the process instance has been terminated because of an external or internal request.
static int STATE_TERMINATING
          States that the (sub)process instance is terminating because of an internal request.
 
Method Summary
 com.ibm.task.api.TKIID getAdminTaskID()
          Returns the ID of the associated administrative task.
 int[] getAvailableActions()
          Returns the actions that can be called in the current process instance execution state.
 java.lang.String getCompensationSphereName()
          Returns the name of the associated compensation sphere.
 java.util.Calendar getCompletionTime()
          Returns the completion time of the process instance.
 java.util.Calendar getCreationTime()
          Returns the creation time of the process instance.
 java.lang.String getCustomProperty(java.lang.String arg0)
          Returns the value of the specified custom property.
 java.lang.String getDescription()
          Returns the description of the process instance.
 java.lang.String getDisplayName()
          Returns the display name of the process instance.
 int getExecutionState()
          Returns the execution state of the process instance.
 java.lang.String getFaultName()
          Returns the name of the fault if the process instance ended with a fault or EngineMissingReplyException if the process instance implements a two-way operation and did not navigate the corresponding reply activity.
 PIID getID()
          Returns the object identifier.
 java.lang.String getInputMessageTypeName()
          Returns the name of the input message type.
 java.lang.String getInputMessageTypeTypeSystemName()
          Deprecated.  
 java.util.Calendar getLastModificationTime()
          Returns the last time a property of the process instance changed.
 java.util.Calendar getLastStateChangeTime()
          Returns the last time the execution state of the process instance changed.
 java.lang.String getName()
          Returns the name of the process instance.
 java.util.List getNamesOfCustomProperties()
          Returns the names of all custom properties.
 java.lang.String getOutputMessageTypeName()
          Returns the name of the output message type.
 java.lang.String getOutputMessageTypeTypeSystemName()
          Deprecated.  
 StaffResultSet getProcessAdministrators()
          Returns the process administrators.
 PTID getProcessTemplateID()
          Returns the object ID of the process template this instance is derived from.
 java.lang.String getProcessTemplateName()
          Returns the name of the process template this instance is derived from.
 java.lang.String getStarter()
          Returns the starter of the process instance.
 java.util.Calendar getStartTime()
          Returns the start time of the process instance.
 PIID getTopLevelProcessInstanceID()
          Returns the object ID of the topmost process instance in the hierarchy.
 java.lang.String getTopLevelProcessInstanceName()
          Returns the name of the topmost process instance in the hierarchy.
 java.util.Calendar getValidFromTime()
          Returns the time the process template became or becomes valid.
 boolean isBusinessRelevant()
          States whether the process instance is a business relevant or an "auxiliary" step.
 boolean isCompensationDefined()
          States whether the process instance can be compensated.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

STATE_TERMINATED

public static final int STATE_TERMINATED
States that the process instance has been terminated because of an external or internal request. If the process instance has been terminated because of an external forceTerminate request, the invoke compensation parameter setting determines whether compensation is started or not (provided that compensation is defined). If the process instance is a top-level process instance and the auto-delete setting is not set or set to 'true', then the process instance is automatically deleted.

See Also:
Constant Field Values

STATE_FAILED

public static final int STATE_FAILED
States that the process instance failed to execute. When the process instance is a top-level process and when compensation is to be done, compensation is started and the execution state is set to Compensated. If the process instance is a top-level process instance and the auto-delete setting is not set or set to 'true', then the process instance is automatically deleted.

See Also:
Constant Field Values

STATE_READY

public static final int STATE_READY
For future use.

See Also:
Constant Field Values

STATE_INDOUBT

public static final int STATE_INDOUBT
States that the compensation has encounterd a problem.

See Also:
Constant Field Values

STATE_RUNNING

public static final int STATE_RUNNING
States that the process instance is running.

See Also:
Constant Field Values

STATE_FINISHED

public static final int STATE_FINISHED
States that the process instance completed successfully. If the process instance is a top-level process instance and the auto-delete setting is not set or set to 'true', then the process instance is automatically deleted.

See Also:
Constant Field Values

STATE_COMPENSATION_FAILED

public static final int STATE_COMPENSATION_FAILED
States that the (sub)proces compensation is failed.

See Also:
Constant Field Values

STATE_COMPENSATED

public static final int STATE_COMPENSATED
States that compensation has been finished for the process instance. All terminated subprocesses are compensated together with their failed top-level process instance. If the process instance is a top-level process instance and the auto-delete setting is not set or set to 'true', then the process instance is automatically deleted.

See Also:
Constant Field Values

STATE_SUSPENDED

public static final int STATE_SUSPENDED
States that the (sub)process instance is supspended

See Also:
Constant Field Values

STATE_FAILING

public static final int STATE_FAILING
States that an expected or unexpected exception has been encountered. The process instance is set to the Failed execution state when all Running or Terminating activities end.

See Also:
Constant Field Values

STATE_COMPENSATING

public static final int STATE_COMPENSATING
States that compensation has been started for the process instance. All terminated subprocesses are compensated together with their failed top-level process instance.

See Also:
Constant Field Values

STATE_TERMINATING

public static final int STATE_TERMINATING
States that the (sub)process instance is terminating because of an internal request. The process instance is set to the Terminated execution state when all Running or Terminating activities end.

See Also:
Constant Field Values
Method Detail

getID

public PIID getID()
Returns the object identifier.


getCompletionTime

public java.util.Calendar getCompletionTime()
Returns the completion time of the process instance. If the process instance is not yet completed, a null object is returned.


getCreationTime

public java.util.Calendar getCreationTime()
Returns the creation time of the process instance.


getProcessTemplateName

public java.lang.String getProcessTemplateName()
Returns the name of the process template this instance is derived from.


getProcessTemplateID

public PTID getProcessTemplateID()
Returns the object ID of the process template this instance is derived from.


getLastModificationTime

public java.util.Calendar getLastModificationTime()
Returns the last time a property of the process instance changed.


getLastStateChangeTime

public java.util.Calendar getLastStateChangeTime()
Returns the last time the execution state of the process instance changed.


getName

public java.lang.String getName()
Returns the name of the process instance.


getCompensationSphereName

public java.lang.String getCompensationSphereName()
Returns the name of the associated compensation sphere. Returns null when when there is no compensation sphere.


getDisplayName

public java.lang.String getDisplayName()
Returns the display name of the process instance. Returns null when a display name is not assigned.


getDescription

public java.lang.String getDescription()
Returns the description of the process instance. If there is no process instance description, the description of the associated process template is returned. If there is no process template description, null is returned. References to variable members specified as %variableName.memberName% are resolved.


getStartTime

public java.util.Calendar getStartTime()
Returns the start time of the process instance.


getExecutionState

public int getExecutionState()
Returns the execution state of the process instance. Possible execution states are: STATE_RUNNING, STATE_FINISHED, STATE_COMPENSATED, STATE_FAILING, STATE_FAILED, STATE_TERMINATING, or STATE_TERMINATED.


getTopLevelProcessInstanceID

public PIID getTopLevelProcessInstanceID()
Returns the object ID of the topmost process instance in the hierarchy. If the current process instance is the topmost process instance itself, the object ID of the current process instance is returned.


getTopLevelProcessInstanceName

public java.lang.String getTopLevelProcessInstanceName()
Returns the name of the topmost process instance in the hierarchy. If the process instance is the topmost process instance itself, the name of the current process instance is returned.


getStarter

public java.lang.String getStarter()
Returns the starter of the process instance.


isCompensationDefined

public boolean isCompensationDefined()
States whether the process instance can be compensated.


getInputMessageTypeName

public java.lang.String getInputMessageTypeName()
Returns the name of the input message type.


getInputMessageTypeTypeSystemName

public java.lang.String getInputMessageTypeTypeSystemName()
Deprecated.  

Returns the name of the type system of the input message.


getOutputMessageTypeName

public java.lang.String getOutputMessageTypeName()
Returns the name of the output message type. Returns null if the process is not yet completed.


getOutputMessageTypeTypeSystemName

public java.lang.String getOutputMessageTypeTypeSystemName()
Deprecated.  

Returns the name of the type system of the output message. Returns null if the process is not yet completed.


getFaultName

public java.lang.String getFaultName()
Returns the name of the fault if the process instance ended with a fault or EngineMissingReplyException if the process instance implements a two-way operation and did not navigate the corresponding reply activity.


getAvailableActions

public int[] getAvailableActions()
Returns the actions that can be called in the current process instance execution state. Refer to ProcessInstanceActions for the set of possible actions.


getCustomProperty

public java.lang.String getCustomProperty(java.lang.String arg0)
Returns the value of the specified custom property. Returns null if the specified custom property is not found.

Parameters:
arg0 - The name of the custom property for which the value is to be read.

getNamesOfCustomProperties

public java.util.List getNamesOfCustomProperties()
Returns the names of all custom properties. Returns an empty list when there are no custom properties.


getProcessAdministrators

public StaffResultSet getProcessAdministrators()
                                        throws WorkItemManagerException,
                                               InvalidLengthException
Returns the process administrators.

Throws:
WorkItemManagerException
InvalidLengthException

getValidFromTime

public java.util.Calendar getValidFromTime()
Returns the time the process template became or becomes valid.


getAdminTaskID

public com.ibm.task.api.TKIID getAdminTaskID()
Returns the ID of the associated administrative task.


isBusinessRelevant

public boolean isBusinessRelevant()
States whether the process instance is a business relevant or an "auxiliary" step. A business relevant step can, for example, be logged into the audit trail.