ActivityInstanceData (IBM Business Process Manager, Release 8)

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ActivityInstanceBean
```
public interface ActivityInstanceData
extends java.io.Serializable
```
Accesses the properties of an activity instance.
An activity instance is created in its initial state 'inactive'. When all control links leading to the activity instance are successfully evaluated and the join condition is fulfilled, the activity instance is activated. For a human task (staff), receive, or pick activity, the people assignment is resolved and work items are created so that the human task activity can be claimed and executed or a message can be send to the waiting activity. For all other activities, the associated implementation, for example, a Web service, is invoked.
If the activity instance completes successfully, navigation continues.
If the activity instance does not complete successfully, the fault is propagated to the enclosing scopes of the activity until it is either handled or the process scope is reached. When the fault is handled, navigation continues from that scope activity. When the fault reaches the process scope, the process is put into the 'Failed' state.

Since:

7.0 - introduced in 5.0

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT`
`static int`	`INVOKED_INSTANCE_TYPE_CHILD_PROCESS` States that the activity calls a long-running process that has "child" autonomy.
`static int`	`INVOKED_INSTANCE_TYPE_CHILD_TASK` States that the activity calls a stand-alone task that has "child" autonomy.
`static int`	`INVOKED_INSTANCE_TYPE_INLINE_TASK` States that the activity calls an inline human task.
`static int`	`INVOKED_INSTANCE_TYPE_NOT_SET` States that the activity does not call a process or inline task, or does not call a process or stand-alone task that have "child" autonomy.
`static int`	`KIND_ABSTRACT_TASK` Do not use - internal only.
`static int`	`KIND_ASSIGN` States that the activity specifies some assignment.
`static int`	`KIND_CALL_ACTIVITY` Do not use - internal only.
`static int`	`KIND_COMPENSATE` States that the activity is a compensating activity.
`static int`	`KIND_COMPENSATE_SCOPE` States that the activity is a compensate scope activity.
`static int`	`KIND_COMPENSATION_END_EVENT` Do not use - internal only.
`static int`	`KIND_COMPENSATION_INTERRUPTING_SUBPROCESS_START_EVENT` Do not use - internal only.
`static int`	`KIND_COMPENSATION_THROW_EVENT` Do not use - internal only.
`static int`	`KIND_CUSTOM` An activity that provides a plug-in mechanism for customer written implementations.
`static int`	`KIND_EMPTY` States that the activity is an empty activity without any implementation.
`static int`	`KIND_ERROR_END_EVENT` Do not use - internal only.
`static int`	`KIND_ERROR_EVENT_SUBPROCESS_ACTIVITY` Do not use - internal only.
`static int`	`KIND_ERROR_INTERRUPTING_BOUNDARY_EVENT` Do not use - internal only.
`static int`	`KIND_ERROR_INTERRUPTING_SUBPROCESS_START_EVENT` Do not use - internal only.
`static int`	`KIND_EVENT_BASED_GATEWAY` Do not use - internal only.
`static int`	`KIND_FLOW` An activity that specifies one or more activities to be performed concurrently.
`static int`	`KIND_FLOW_END` Do not use - internal only.
`static int`	`KIND_FOR_EACH_PARALLEL` States that the activity is a forEach activity with parallel branches.
`static int`	`KIND_FOR_EACH_PARALLEL_END` Do not use - internal only.
`static int`	`KIND_FOR_EACH_SERIAL` States that the activity is a forEach activity with no parallel branches.
`static int`	`KIND_FOR_EACH_SERIAL_END` Do not use - internal only.
`static int`	`KIND_INVOKE` States that the activity describes some external service to be invoked.
`static int`	`KIND_INVOKE_END` Do not use - internal only.
`static int`	`KIND_IOR_GATEWAY` Do not use - internal only.
`static int`	`KIND_IOR_IN_GATEWAY` Do not use - internal only.
`static int`	`KIND_MESSAGE_CATCH_EVENT` Do not use - internal only.
`static int`	`KIND_MESSAGE_END_EVENT` Do not use - internal only.
`static int`	`KIND_MESSAGE_EVENT_SUBPROCESS_ACTIVITY` Do not use - internal only.
`static int`	`KIND_MESSAGE_NONINTERRUPTING_SUBPROCESS_START_EVENT` Do not use - internal only.
`static int`	`KIND_MESSAGE_START_EVENT` Do not use - internal only.
`static int`	`KIND_MESSAGE_THROW_EVENT` Do not use - internal only.
`static int`	`KIND_NONE_END_EVENT` Do not use - internal only.
`static int`	`KIND_NONE_START_EVENT` Do not use - internal only.
`static int`	`KIND_PARALLEL_GATEWAY` Do not use - internal only.
`static int`	`KIND_PICK` States that the activity is an activity that waits for various input.
`static int`	`KIND_PICK_END` Do not use - internal only.
`static int`	`KIND_RECEIVE` States that the activity is an activity that waits for input.
`static int`	`KIND_RECEIVE_TASK` Do not use - internal only.
`static int`	`KIND_REPEAT_UNTIL` An activity that is repeated until an exit condition is met.
`static int`	`KIND_REPEAT_UNTIL_END` Do not use - internal only.
`static int`	`KIND_REPLY` An activity that allows the process to send a message in reply to a message that was received.
`static int`	`KIND_RETHROW` States that the activity rethrows a fault.
`static int`	`KIND_SCOPE` Describes a scope construct that allows for own variable definitions, fault and compensation handlers.
`static int`	`KIND_SCOPE_END` Do not use - internal only.
`static int`	`KIND_SCRIPT` States that the activity is implemented by plain Java code.
`static int`	`KIND_SCRIPT_TASK` Do not use - internal only.
`static int`	`KIND_SEND_TASK` Do not use - internal only.
`static int`	`KIND_SEQUENCE` Describes a sequence construct that contains activities to be performed sequentially.
`static int`	`KIND_SEQUENCE_END` Do not use - internal only.
`static int`	`KIND_SERVICE_TASK` Do not use - internal only.
`static int`	`KIND_STAFF` States that the activity involves people for its execution.
`static int`	`KIND_SUBPROCESS_ACTIVITY` Do not use - internal only.
`static int`	`KIND_SWITCH` Describes a switch construct that allows to select an activity from a set of choices.
`static int`	`KIND_SWITCH_END` Do not use - internal only.
`static int`	`KIND_TERMINATE` States that the activity terminates execution.
`static int`	`KIND_TERMINATE_END_EVENT` Do not use - internal only.
`static int`	`KIND_THROW` States that the activity throws a fault.
`static int`	`KIND_TIMER_CATCH_EVENT` Do not use - internal only.
`static int`	`KIND_TIMER_EVENT_SUBPROCESS_ACTIVITY` Do not use - internal only.
`static int`	`KIND_TIMER_INTERRUPTING_BOUNDARY_EVENT` Do not use - internal only.
`static int`	`KIND_TIMER_NONINTERRUPTING_SUBPROCESS_START_EVENT` Do not use - internal only.
`static int`	`KIND_USER_TASK` Do not use - internal only.
`static int`	`KIND_WAIT` An activity that allows to wait for a given period of time.
`static int`	`KIND_WHILE` An activity that is repeated until a certain criteria is met.
`static int`	`KIND_WHILE_END` Do not use - internal only.
`static int`	`KIND_XOR_GATEWAY` Do not use - internal only.
`static int`	`STATE_CLAIMED` States that the activity has been claimed.
`static int`	`STATE_EXPIRED` States that the activity ended because its allowed duration timed-out.
`static int`	`STATE_FAILED` States that the activity failed to execute.
`static int`	`STATE_FAILING` States that the activity is failing.
`static int`	`STATE_FINISHED` States that the activity finished execution successfully.
`static int`	`STATE_INACTIVE` States that the activity has not yet been scheduled for execution.
`static int`	`STATE_PROCESSING_UNDO` States that the activity is retried due to a transaction rollback and that the activity waits for the microflow that it invokes to complete its compensation actions for the first invoke.
`static int`	`STATE_READY` States that the activity is ready to be started or claimed.
`static int`	`STATE_RUNNING` States that the activity is running.
`static int`	`STATE_SKIPPED` States that the activity has been skipped because navigation followed a a different control path.
`static int`	`STATE_STOPPED` States that the activity is stopped because of a failure.
`static int`	`STATE_TERMINATED` States that the activity has been terminated because of an external or internal request.
`static int`	`STATE_TERMINATING` States that the activity is terminating.
`static int`	`STATE_WAITING` States that a receive or pick activity is waiting for a corresponding event to occur.
`static int`	`STOP_REASON_ACTIVATION_FAILED` States that the activation of the activity failed.
`static int`	`STOP_REASON_EXIT_CONDITION_FALSE` States that the exit condition of the activity evaluated to false.
`static int`	`STOP_REASON_FOLLOW_ON_NAVIGATION_FAILED` States that the follow on navigation of the activity failed.
`static int`	`STOP_REASON_IMPLEMENTATION_FAILED` States that the implementation of the activity failed.
`static int`	`STOP_REASON_UNSPECIFIED` States that the activity is not stopped.
`static int`	`SUB_STATE_EXPIRING` Do not use - internal only.
`static int`	`SUB_STATE_FAILING` Do not use - internal only.
`static int`	`SUB_STATE_FINISHING` Do not use - internal only.
`static int`	`SUB_STATE_NONE` Do not use - internal only.
`static int`	`SUB_STATE_RESTARTING` Do not use - internal only.
`static int`	`SUB_STATE_SKIPPING` Do not use - internal only.

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.Calendar`	`getActivationTime()` Returns the activation time of the activity instance.
`ATID`	`getActivityTemplateID()` Returns the object ID of the associated activity template.
`TKIID`	`getAdminTaskID()` Returns the ID of the associated administration task.
`java.lang.String`	`getApplicationName()` Returns the name of the enterprise application the activity belongs to.
`int[]`	`getAvailableActions()` Returns the actions that can be called in the current activity instance execution state.
`java.util.Calendar`	`getCompletionTime()` Returns the completion time of the activity 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 activity instance.
`java.lang.String`	`getDisplayName()` Returns the display name of the activity instance.
`com.ibm.bpe.api.FEIID`	`getEnclosingForEachID()` Returns the ID of the enclosing for-each activity if the activity is part of an for-each construct.
`com.ibm.bpe.api.EHIID`	`getEventHandlerInstanceID()` Returns the ID of the associated event handler instance if the activity is part of an event handler.
`int`	`getExecutionState()` Returns the execution state of the activity instance.
`java.util.Calendar`	`getExpirationTime()` Returns the time when the activity instance will expire or expired.
`java.util.List`	`getFaultNames()` Returns the names of faults associated to the activity instance.
`AIID`	`getID()` Returns the object identifier.
`java.lang.String`	`getInputMessageTypeName()` Returns the name of the input message type.
`java.lang.String`	`getInputMessageTypeTypeSystemName()` Deprecated. As of version 6.0, no replacement.
`OID`	`getInvokedInstanceID()` Returns the object ID of the process or task instance that is called by this activity.
`int`	`getInvokedInstanceType()` Returns the type of object called by this activity, that is, describes the type of the object ID returned by `getInvokedInstanceID`.
`int`	`getKind()` Returns the kind of the activity, for example, whether the activity is a pick or receive activity.
`java.util.Calendar`	`getLastModificationTime()` Returns the last time a property of the activity instance changed.
`java.util.Calendar`	`getLastStateChangeTime()` Returns the last time the execution state of the activity instance changed.
`java.lang.String`	`getName()` Returns the name of the activity 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. As of version 6.0, no replacement.
`java.lang.String`	`getOwner()` Returns the owner of the activity instance.
`java.util.Calendar`	`getPreviousExpirationTime()` Returns the time the activity instance expired for the first time.
`StaffResultSet`	`getProcessAdministrators()` Returns the administrators of the process instance that contains the activity instance.
`TKIID`	`getProcessAdminTaskID()` Returns the ID of the administration task associated to the containing process instance.
`PIID`	`getProcessInstanceID()` Returns the object ID of the containing process instance.
`java.lang.String`	`getProcessInstanceName()` Returns the name of the process instance the activity belongs to.
`PTID`	`getProcessTemplateID()` Returns the object ID of the process template that contains the activity definition.
`java.lang.String`	`getProcessTemplateName()` Returns the name of the first process template in the hierarchy that contains the activity definition.
`com.ibm.bpe.api.SIID`	`getScopeID()` Returns the ID of the associated scope.
`com.ibm.bpe.api.STID`	`getScopeTemplateID()` Returns the ID of the scope template that is associated to the scope the activity is part of.
`java.util.Calendar`	`getStartTime()` Returns the start time of the activity instance.
`int`	`getStopReason()` Returns the reason why the activity is in the Stopped execution state.
`int`	`getSubState()` Returns the sub state of the activity instance Possible values are: SUB_STATE_NONE, SUB_STATE_EXPIRING, SUB_STATE_SKIPPING, SUB_STATE_RESTARTING, SUB_STATE_FINISHING, SUB_STATE_FAILING.
`TKIID`	`getTaskID()` For human task activities, returns the ID of the associated inline to-do aka participating task.
`ProcessException`	`getUnhandledException()` Returns the reason why the activity is in the Stopped execution state.
`boolean`	`isBusinessRelevant()` States whether the activity instance is a business relevant or an "auxiliary" step.
`boolean`	`isContinueOnError()` States whether the activity instance stops navigation of the process in case of an unhandled error or not.
`boolean`	`isSkipRequested()` States whether the activity instance is to be skipped when reached during navigation.

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    See Also:
    Constant Field Values
  - STATE_FINISHED
```
static final int STATE_FINISHED
```
    States that the activity finished execution successfully.
    
    See Also:
    Constant Field Values
  - STATE_PROCESSING_UNDO
```
static final int STATE_PROCESSING_UNDO
```
    States that the activity is retried due to a transaction rollback and that the activity waits for the microflow that it invokes to complete its compensation actions for the first invoke.
    
    See Also:
    Constant Field Values
  - STATE_SKIPPED
```
static final int STATE_SKIPPED
```
    States that the activity has been skipped because navigation followed a a different control path.
    
    See Also:
    Constant Field Values
  - STATE_FAILED
```
static final int STATE_FAILED
```
    States that the activity failed to execute.
    
    See Also:
    Constant Field Values
  - STATE_CLAIMED
```
static final int STATE_CLAIMED
```
    States that the activity has been claimed.
    
    See Also:
    Constant Field Values
  - STATE_TERMINATING
```
static final int STATE_TERMINATING
```
    States that the activity is terminating. The activity is set to the Terminated execution state when all contained running or terminating activities end.
    
    See Also:
    Constant Field Values
  - STATE_RUNNING
```
static final int STATE_RUNNING
```
    States that the activity is running.
    
    See Also:
    Constant Field Values
  - STATE_TERMINATED
```
static final int STATE_TERMINATED
```
    States that the activity has been terminated because of an external or internal request.
    
    See Also:
    Constant Field Values
  - STATE_READY
```
static final int STATE_READY
```
    States that the activity is ready to be started or claimed.
    
    See Also:
    Constant Field Values
  - STATE_FAILING
```
static final int STATE_FAILING
```
    States that the activity is failing. The activity is set to the Failed execution state when all contained running or terminating activities end.
    
    See Also:
    Constant Field Values
  - STATE_EXPIRED
```
static final int STATE_EXPIRED
```
    States that the activity ended because its allowed duration timed-out.
    
    See Also:
    Constant Field Values
  - STATE_INACTIVE
```
static final int STATE_INACTIVE
```
    States that the activity has not yet been scheduled for execution.
    
    See Also:
    Constant Field Values
  - STATE_WAITING
```
static final int STATE_WAITING
```
    States that a receive or pick activity is waiting for a corresponding event to occur.
    
    See Also:
    Constant Field Values
  - STATE_STOPPED
```
static final int STATE_STOPPED
```
    States that the activity is stopped because of a failure. A process administrator can repair the activity by either calling forceRetry or forceComplete.
    
    See Also:
    Constant Field Values
  - KIND_FOR_EACH_PARALLEL_END
```
static final int KIND_FOR_EACH_PARALLEL_END
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_NONE_START_EVENT
```
static final int KIND_NONE_START_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_ERROR_INTERRUPTING_BOUNDARY_EVENT
```
static final int KIND_ERROR_INTERRUPTING_BOUNDARY_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_INVOKE
```
static final int KIND_INVOKE
```
    States that the activity describes some external service to be invoked.
    
    See Also:
    Constant Field Values
  - KIND_FOR_EACH_PARALLEL
```
static final int KIND_FOR_EACH_PARALLEL
```
    States that the activity is a forEach activity with parallel branches.
    
    See Also:
    Constant Field Values
  - KIND_SEQUENCE_END
```
static final int KIND_SEQUENCE_END
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_ERROR_INTERRUPTING_SUBPROCESS_START_EVENT
```
static final int KIND_ERROR_INTERRUPTING_SUBPROCESS_START_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_SEQUENCE
```
static final int KIND_SEQUENCE
```
    Describes a sequence construct that contains activities to be performed sequentially.
    
    See Also:
    Constant Field Values
  - KIND_USER_TASK
```
static final int KIND_USER_TASK
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_TIMER_EVENT_SUBPROCESS_ACTIVITY
```
static final int KIND_TIMER_EVENT_SUBPROCESS_ACTIVITY
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_ABSTRACT_TASK
```
static final int KIND_ABSTRACT_TASK
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_MESSAGE_EVENT_SUBPROCESS_ACTIVITY
```
static final int KIND_MESSAGE_EVENT_SUBPROCESS_ACTIVITY
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_RECEIVE
```
static final int KIND_RECEIVE
```
    States that the activity is an activity that waits for input.
    
    See Also:
    Constant Field Values
  - KIND_ERROR_EVENT_SUBPROCESS_ACTIVITY
```
static final int KIND_ERROR_EVENT_SUBPROCESS_ACTIVITY
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_WHILE_END
```
static final int KIND_WHILE_END
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_TIMER_NONINTERRUPTING_SUBPROCESS_START_EVENT
```
static final int KIND_TIMER_NONINTERRUPTING_SUBPROCESS_START_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_WHILE
```
static final int KIND_WHILE
```
    An activity that is repeated until a certain criteria is met.
    
    See Also:
    Constant Field Values
  - KIND_IOR_GATEWAY
```
static final int KIND_IOR_GATEWAY
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_COMPENSATION_THROW_EVENT
```
static final int KIND_COMPENSATION_THROW_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_FOR_EACH_SERIAL_END
```
static final int KIND_FOR_EACH_SERIAL_END
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_FOR_EACH_SERIAL
```
static final int KIND_FOR_EACH_SERIAL
```
    States that the activity is a forEach activity with no parallel branches.
    
    See Also:
    Constant Field Values
  - KIND_COMPENSATION_INTERRUPTING_SUBPROCESS_START_EVENT
```
static final int KIND_COMPENSATION_INTERRUPTING_SUBPROCESS_START_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_MESSAGE_END_EVENT
```
static final int KIND_MESSAGE_END_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_ERROR_END_EVENT
```
static final int KIND_ERROR_END_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_PARALLEL_GATEWAY
```
static final int KIND_PARALLEL_GATEWAY
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_NONE_END_EVENT
```
static final int KIND_NONE_END_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_MESSAGE_START_EVENT
```
static final int KIND_MESSAGE_START_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_SERVICE_TASK
```
static final int KIND_SERVICE_TASK
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_SWITCH_END
```
static final int KIND_SWITCH_END
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_MESSAGE_THROW_EVENT
```
static final int KIND_MESSAGE_THROW_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_SWITCH
```
static final int KIND_SWITCH
```
    Describes a switch construct that allows to select an activity from a set of choices.
    
    See Also:
    Constant Field Values
  - KIND_TIMER_INTERRUPTING_BOUNDARY_EVENT
```
static final int KIND_TIMER_INTERRUPTING_BOUNDARY_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_WAIT
```
static final int KIND_WAIT
```
    An activity that allows to wait for a given period of time.
    
    See Also:
    Constant Field Values
  - KIND_EMPTY
```
static final int KIND_EMPTY
```
    States that the activity is an empty activity without any implementation. An empty activity is often used as synchronization point of parallel paths in the process.
    
    See Also:
    Constant Field Values
  - KIND_COMPENSATE
```
static final int KIND_COMPENSATE
```
    States that the activity is a compensating activity.
    
    See Also:
    Constant Field Values
  - KIND_SCOPE_END
```
static final int KIND_SCOPE_END
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_RETHROW
```
static final int KIND_RETHROW
```
    States that the activity rethrows a fault.
    
    See Also:
    Constant Field Values
  - KIND_IOR_IN_GATEWAY
```
static final int KIND_IOR_IN_GATEWAY
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_EVENT_BASED_GATEWAY
```
static final int KIND_EVENT_BASED_GATEWAY
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_SCOPE
```
static final int KIND_SCOPE
```
    Describes a scope construct that allows for own variable definitions, fault and compensation handlers.
    
    See Also:
    Constant Field Values
  - KIND_RECEIVE_TASK
```
static final int KIND_RECEIVE_TASK
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_TERMINATE_END_EVENT
```
static final int KIND_TERMINATE_END_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_SCRIPT_TASK
```
static final int KIND_SCRIPT_TASK
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_TIMER_CATCH_EVENT
```
static final int KIND_TIMER_CATCH_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_MESSAGE_CATCH_EVENT
```
static final int KIND_MESSAGE_CATCH_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_STAFF
```
static final int KIND_STAFF
```
    States that the activity involves people for its execution.
    
    See Also:
    Constant Field Values
  - KIND_SCRIPT
```
static final int KIND_SCRIPT
```
    States that the activity is implemented by plain Java code.
    
    See Also:
    Constant Field Values
  - KIND_TERMINATE
```
static final int KIND_TERMINATE
```
    States that the activity terminates execution.
    
    See Also:
    Constant Field Values
  - KIND_THROW
```
static final int KIND_THROW
```
    States that the activity throws a fault.
    
    See Also:
    Constant Field Values
  - KIND_COMPENSATION_END_EVENT
```
static final int KIND_COMPENSATION_END_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_REPLY
```
static final int KIND_REPLY
```
    An activity that allows the process to send a message in reply to a message that was received.
    
    See Also:
    Constant Field Values
  - KIND_REPEAT_UNTIL_END
```
static final int KIND_REPEAT_UNTIL_END
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_MESSAGE_NONINTERRUPTING_SUBPROCESS_START_EVENT
```
static final int KIND_MESSAGE_NONINTERRUPTING_SUBPROCESS_START_EVENT
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_REPEAT_UNTIL
```
static final int KIND_REPEAT_UNTIL
```
    An activity that is repeated until an exit condition is met.
    
    See Also:
    Constant Field Values
  - KIND_CALL_ACTIVITY
```
static final int KIND_CALL_ACTIVITY
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_PICK_END
```
static final int KIND_PICK_END
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_PICK
```
static final int KIND_PICK
```
    States that the activity is an activity that waits for various input.
    
    See Also:
    Constant Field Values
  - KIND_SEND_TASK
```
static final int KIND_SEND_TASK
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_SUBPROCESS_ACTIVITY
```
static final int KIND_SUBPROCESS_ACTIVITY
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_FLOW_END
```
static final int KIND_FLOW_END
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_XOR_GATEWAY
```
static final int KIND_XOR_GATEWAY
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - KIND_COMPENSATE_SCOPE
```
static final int KIND_COMPENSATE_SCOPE
```
    States that the activity is a compensate scope activity.
    
    See Also:
    Constant Field Values
  - KIND_FLOW
```
static final int KIND_FLOW
```
    An activity that specifies one or more activities to be performed concurrently.
    
    See Also:
    Constant Field Values
  - KIND_ASSIGN
```
static final int KIND_ASSIGN
```
    States that the activity specifies some assignment.
    
    See Also:
    Constant Field Values
  - KIND_CUSTOM
```
static final int KIND_CUSTOM
```
    An activity that provides a plug-in mechanism for customer written implementations.
    
    See Also:
    Constant Field Values
  - KIND_INVOKE_END
```
static final int KIND_INVOKE_END
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - STOP_REASON_FOLLOW_ON_NAVIGATION_FAILED
```
static final int STOP_REASON_FOLLOW_ON_NAVIGATION_FAILED
```
    States that the follow on navigation of the activity failed.
    
    See Also:
    Constant Field Values
  - STOP_REASON_ACTIVATION_FAILED
```
static final int STOP_REASON_ACTIVATION_FAILED
```
    States that the activation of the activity failed.
    
    See Also:
    Constant Field Values
  - STOP_REASON_UNSPECIFIED
```
static final int STOP_REASON_UNSPECIFIED
```
    States that the activity is not stopped.
    
    See Also:
    Constant Field Values
  - STOP_REASON_EXIT_CONDITION_FALSE
```
static final int STOP_REASON_EXIT_CONDITION_FALSE
```
    States that the exit condition of the activity evaluated to false. Note: this field must be kept in sync with MigrationFront.stopReason.
    
    See Also:
    Constant Field Values
  - STOP_REASON_IMPLEMENTATION_FAILED
```
static final int STOP_REASON_IMPLEMENTATION_FAILED
```
    States that the implementation of the activity failed.
    
    See Also:
    Constant Field Values
  - INVOKED_INSTANCE_TYPE_CHILD_TASK
```
static final int INVOKED_INSTANCE_TYPE_CHILD_TASK
```
    States that the activity calls a stand-alone task that has "child" autonomy.
    
    See Also:
    Constant Field Values
  - INVOKED_INSTANCE_TYPE_NOT_SET
```
static final int INVOKED_INSTANCE_TYPE_NOT_SET
```
    States that the activity does not call a process or inline task, or does not call a process or stand-alone task that have "child" autonomy.
    
    See Also:
    Constant Field Values
  - INVOKED_INSTANCE_TYPE_INLINE_TASK
```
static final int INVOKED_INSTANCE_TYPE_INLINE_TASK
```
    States that the activity calls an inline human task.
    
    See Also:
    Constant Field Values
  - INVOKED_INSTANCE_TYPE_CHILD_PROCESS
```
static final int INVOKED_INSTANCE_TYPE_CHILD_PROCESS
```
    States that the activity calls a long-running process that has "child" autonomy. The process containing this activity and the process called are both long-running.
    
    See Also:
    Constant Field Values
  - SUB_STATE_RESTARTING
```
static final int SUB_STATE_RESTARTING
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - SUB_STATE_FINISHING
```
static final int SUB_STATE_FINISHING
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - SUB_STATE_NONE
```
static final int SUB_STATE_NONE
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - SUB_STATE_FAILING
```
static final int SUB_STATE_FAILING
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - SUB_STATE_EXPIRING
```
static final int SUB_STATE_EXPIRING
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - SUB_STATE_SKIPPING
```
static final int SUB_STATE_SKIPPING
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
- Method Detail
  - getID
```
AIID getID()
```
    Returns the object identifier.
  - getActivationTime
```
java.util.Calendar getActivationTime()
```
    Returns the activation time of the activity instance.
  - getCompletionTime
```
java.util.Calendar getCompletionTime()
```
    Returns the completion time of the activity instance. Returns null when the activity instance is not yet complete.
  - getLastModificationTime
```
java.util.Calendar getLastModificationTime()
```
    Returns the last time a property of the activity instance changed.
  - getLastStateChangeTime
```
java.util.Calendar getLastStateChangeTime()
```
    Returns the last time the execution state of the activity instance changed.
  - getName
```
java.lang.String getName()
```
    Returns the name of the activity instance. Returns null if there is no name.
  - getDisplayName
```
java.lang.String getDisplayName()
```
    Returns the display name of the activity instance. Returns null when a display name is not assigned.
  - getDescription
```
java.lang.String getDescription()
```
    Returns the description of the activity instance. If there is no activity instance description, the description of the associated activity template is returned. If there is no activity template description, null is returned. References to variable members specified as %variableName.memberName% are resolved.
  - getOwner
```
java.lang.String getOwner()
```
    Returns the owner of the activity instance. Returns null when an owner is not assigned.
  - getStartTime
```
java.util.Calendar getStartTime()
```
    Returns the start time of the activity instance. Returns null when the activity instance is not yet started.
  - getExecutionState
```
int getExecutionState()
```
    Returns the execution state of the activity instance.
    Possible states are: STATE_INACTIVE, STATE_READY, STATE_RUNNING, STATE_CLAIMED, STATE_FINISHED, STATE_FAILING, STATE_FAILED, STATE_SKIPPED, STATE_TERMINATED, STATE_TERMINATING, STATE_WAITING, STATE_STOPPED, or STATE_EXPIRED.
  - getExpirationTime
```
java.util.Calendar getExpirationTime()
```
    Returns the time when the activity instance will expire or expired. Returns null when there is no expiration time.
  - getKind
```
int getKind()
```
    Returns the kind of the activity, for example, whether the activity is a pick or receive activity.
  - getUnhandledException
```
ProcessException getUnhandledException()
```
    Returns the reason why the activity is in the Stopped execution state.
  - getStopReason
```
int getStopReason()
```
    Returns the reason why the activity is in the Stopped execution state.
    Possible values are: STOP_REASON_UNSPECIFIED, STOP_REASON_ACTIVATION_FAILED, STOP_REASON_IMPLEMENTATION_FAILED, STOP_REASON_FOLLOW_ON_NAVIGATION_FAILED, or STOP_REASON_EXIT_CONDITION_FALSE.
    
    Since:
    
    6.1.2.
  - getProcessInstanceID
```
PIID getProcessInstanceID()
```
    Returns the object ID of the containing process instance.
  - getProcessTemplateID
```
PTID getProcessTemplateID()
```
    Returns the object ID of the process template that contains the activity definition.
  - getFaultNames
```
java.util.List getFaultNames()
```
    Returns the names of faults associated to the activity instance.
  - getInputMessageTypeName
```
java.lang.String getInputMessageTypeName()
```
    Returns the name of the input message type. A BPEL process returns a value only when there is a single input variable associated.
  - getInputMessageTypeTypeSystemName
```
java.lang.String getInputMessageTypeTypeSystemName()
```
    Deprecated. As of version 6.0, no replacement.
    
    Returns the name of the type system of the input message. A BPEL process returns a value only when there is a single input variable associated.
  - getOutputMessageTypeName
```
java.lang.String getOutputMessageTypeName()
```
    Returns the name of the output message type. A BPEL process returns a value only when there is a single output variable associated.
  - getOutputMessageTypeTypeSystemName
```
java.lang.String getOutputMessageTypeTypeSystemName()
```
    Deprecated. As of version 6.0, no replacement.
    
    Returns the name of the type system of the output message. A BPEL process returns a value only when there is a single output variable associated.
  - getAvailableActions
```
int[] getAvailableActions()
```
    Returns the actions that can be called in the current activity instance execution state. Refer to ActivityInstanceActions for the set of possible actions.
  - getCustomProperty
```
java.lang.String getCustomProperty(java.lang.String arg0)
```
    Returns the value of the specified custom property. Returns null when the specified custom property is not found.
    
    Parameters:
    arg0 - The name of the custom property for which the value is to be read.
  - getNamesOfCustomProperties
```
java.util.List getNamesOfCustomProperties()
```
    Returns the names of all custom properties. Returns an empty list when there are no custom properties.
  - getProcessAdministrators
```
StaffResultSet getProcessAdministrators()
                                        throws WorkItemManagerException,
                                               InvalidLengthException
```
    Returns the administrators of the process instance that contains the activity instance.
    
    Throws:
    
    WorkItemManagerException
    
    InvalidLengthException
  - getApplicationName
```
java.lang.String getApplicationName()
```
    Returns the name of the enterprise application the activity belongs to.
  - getProcessTemplateName
```
java.lang.String getProcessTemplateName()
```
    Returns the name of the first process template in the hierarchy that contains the activity definition.
  - getProcessInstanceName
```
java.lang.String getProcessInstanceName()
```
    Returns the name of the process instance the activity belongs to.
  - isBusinessRelevant
```
boolean isBusinessRelevant()
```
    States whether the activity instance is a business relevant or an "auxiliary" step.
  - getTaskID
```
TKIID getTaskID()
```
    For human task activities, returns the ID of the associated inline to-do aka participating task. Returns null when the activity is no human task activity calling an inline to-do task.
  - getAdminTaskID
```
TKIID getAdminTaskID()
```
    Returns the ID of the associated administration task. Returns null if there is no administration task.
  - getProcessAdminTaskID
```
TKIID getProcessAdminTaskID()
```
    Returns the ID of the administration task associated to the containing process instance. Returns null if there is no administration task.
  - getScopeID
```
com.ibm.bpe.api.SIID getScopeID()
```
    Returns the ID of the associated scope.
    
    Since:
    
    6.1.2.
  - getScopeTemplateID
```
com.ibm.bpe.api.STID getScopeTemplateID()
```
    Returns the ID of the scope template that is associated to the scope the activity is part of.
    
    Since:
    
    6.1.2.
  - getEventHandlerInstanceID
```
com.ibm.bpe.api.EHIID getEventHandlerInstanceID()
```
    Returns the ID of the associated event handler instance if the activity is part of an event handler. Returns null when the activity is not part of an event handler.
    
    Since:
    
    6.1.2.
  - getEnclosingForEachID
```
com.ibm.bpe.api.FEIID getEnclosingForEachID()
```
    Returns the ID of the enclosing for-each activity if the activity is part of an for-each construct. Returns null when the activity is not part of a for-each construct.
    
    Since:
    
    6.1.2.
  - isSkipRequested
```
boolean isSkipRequested()
```
    States whether the activity instance is to be skipped when reached during navigation.
    
    Since:
    
    6.1.2.
  - isContinueOnError
```
boolean isContinueOnError()
```
    States whether the activity instance stops navigation of the process in case of an unhandled error or not. True states that navigation continues in case of an unhandled error. False states that navigation stops in case of an unhandled error to allow for repair.
    This setting can be overwritten when calling forceComplete or forceRetry.
    
    Since:
    
    6.1.2.
  - getActivityTemplateID
```
ATID getActivityTemplateID()
```
    Returns the object ID of the associated activity template.
    
    Since:
    
    6.2.
  - getInvokedInstanceID
```
OID getInvokedInstanceID()
```
    Returns the object ID of the process or task instance that is called by this activity. Returns null for activities navigated by an IBM Websphere Process Server Version less than 6.2, when the activity does not call a long-running process or task, when the long-running process or stand-alone task called does not have child autonomy, or when the inline task called is no human task.
    You can use getInvokedInstanceType to determine whether the object ID returned is a PIID or TKIID.
    
    Since:
    
    6.2.
  - getInvokedInstanceType
```
int getInvokedInstanceType()
```
    Returns the type of object called by this activity, that is, describes the type of the object ID returned by getInvokedInstanceID. Using this method, you can determine whether a PIID or TKIID is returned.
    States INVOKED_INSTANCE_TYPE_NOT_SET when no object ID is returned by getInvokedInstanceID.
    
    Since:
    
    6.2.
  - getSubState
```
int getSubState()
```
    Returns the sub state of the activity instance
    Possible values are: SUB_STATE_NONE, SUB_STATE_EXPIRING, SUB_STATE_SKIPPING, SUB_STATE_RESTARTING, SUB_STATE_FINISHING, SUB_STATE_FAILING.
    
    Since:
    
    7.0.
  - getPreviousExpirationTime
```
java.util.Calendar getPreviousExpirationTime()
```
    Returns the time the activity instance expired for the first time. Returns null when the activity did not expire.
    
    Since:
    
    7.0.

COPYRIGHT

STATE_FINISHED

STATE_PROCESSING_UNDO

STATE_SKIPPED

STATE_FAILED

STATE_CLAIMED

STATE_TERMINATING

STATE_RUNNING

STATE_TERMINATED

STATE_READY

STATE_FAILING

STATE_EXPIRED

STATE_INACTIVE

STATE_WAITING

STATE_STOPPED

KIND_FOR_EACH_PARALLEL_END

KIND_NONE_START_EVENT

KIND_ERROR_INTERRUPTING_BOUNDARY_EVENT

KIND_INVOKE

KIND_FOR_EACH_PARALLEL

KIND_SEQUENCE_END

KIND_ERROR_INTERRUPTING_SUBPROCESS_START_EVENT

KIND_SEQUENCE

KIND_USER_TASK

KIND_TIMER_EVENT_SUBPROCESS_ACTIVITY

KIND_ABSTRACT_TASK

KIND_MESSAGE_EVENT_SUBPROCESS_ACTIVITY

KIND_RECEIVE

KIND_ERROR_EVENT_SUBPROCESS_ACTIVITY

KIND_WHILE_END

KIND_TIMER_NONINTERRUPTING_SUBPROCESS_START_EVENT

KIND_WHILE

KIND_IOR_GATEWAY

KIND_COMPENSATION_THROW_EVENT

KIND_FOR_EACH_SERIAL_END

KIND_FOR_EACH_SERIAL

KIND_COMPENSATION_INTERRUPTING_SUBPROCESS_START_EVENT

KIND_MESSAGE_END_EVENT

KIND_ERROR_END_EVENT

KIND_PARALLEL_GATEWAY

KIND_NONE_END_EVENT

KIND_MESSAGE_START_EVENT

KIND_SERVICE_TASK

KIND_SWITCH_END

KIND_MESSAGE_THROW_EVENT

KIND_SWITCH

KIND_TIMER_INTERRUPTING_BOUNDARY_EVENT

KIND_WAIT

KIND_EMPTY

KIND_COMPENSATE

KIND_SCOPE_END

KIND_RETHROW

KIND_IOR_IN_GATEWAY

KIND_EVENT_BASED_GATEWAY

KIND_SCOPE

KIND_RECEIVE_TASK

KIND_TERMINATE_END_EVENT

KIND_SCRIPT_TASK

KIND_TIMER_CATCH_EVENT

KIND_MESSAGE_CATCH_EVENT

KIND_STAFF

KIND_SCRIPT

KIND_TERMINATE

KIND_THROW

KIND_COMPENSATION_END_EVENT

KIND_REPLY

KIND_REPEAT_UNTIL_END

KIND_MESSAGE_NONINTERRUPTING_SUBPROCESS_START_EVENT

KIND_REPEAT_UNTIL

KIND_CALL_ACTIVITY

KIND_PICK_END

KIND_PICK

KIND_SEND_TASK

KIND_SUBPROCESS_ACTIVITY

KIND_FLOW_END

KIND_XOR_GATEWAY

KIND_COMPENSATE_SCOPE

KIND_FLOW

KIND_ASSIGN

KIND_CUSTOM