com.ibm.bpe.api

Interface ActivityInstanceData

All Superinterfaces:
java.io.Serializable
All known implementing classes:
ActivityInstanceBean

  1. public interface ActivityInstanceData
  2. 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

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

Method Summary

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

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

STATE_FINISHED

  1. static final int STATE_FINISHED
States that the activity finished execution successfully.
See Also:

STATE_PROCESSING_UNDO

  1. 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:

STATE_SKIPPED

  1. static final int STATE_SKIPPED
States that the activity has been skipped because navigation followed a a different control path.
See Also:

STATE_FAILED

  1. static final int STATE_FAILED
States that the activity failed to execute.
See Also:

STATE_CLAIMED

  1. static final int STATE_CLAIMED
States that the activity has been claimed.
See Also:

STATE_TERMINATING

  1. 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:

STATE_RUNNING

  1. static final int STATE_RUNNING
States that the activity is running.
See Also:

STATE_TERMINATED

  1. static final int STATE_TERMINATED
States that the activity has been terminated because of an external or internal request.
See Also:

STATE_READY

  1. static final int STATE_READY
States that the activity is ready to be started or claimed.
See Also:

STATE_FAILING

  1. 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:

STATE_EXPIRED

  1. static final int STATE_EXPIRED
States that the activity ended because its allowed duration timed-out.
See Also:

STATE_INACTIVE

  1. static final int STATE_INACTIVE
States that the activity has not yet been scheduled for execution.
See Also:

STATE_WAITING

  1. static final int STATE_WAITING
States that a receive or pick activity is waiting for a corresponding event to occur.
See Also:

STATE_STOPPED

  1. 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:

KIND_FOR_EACH_PARALLEL_END

  1. static final int KIND_FOR_EACH_PARALLEL_END
Do not use - internal only.
See Also:

KIND_NONE_START_EVENT

  1. static final int KIND_NONE_START_EVENT
Do not use - internal only.
See Also:

KIND_ERROR_INTERRUPTING_BOUNDARY_EVENT

  1. static final int KIND_ERROR_INTERRUPTING_BOUNDARY_EVENT
Do not use - internal only.
See Also:

KIND_INVOKE

  1. static final int KIND_INVOKE
States that the activity describes some external service to be invoked.
See Also:

KIND_FOR_EACH_PARALLEL

  1. static final int KIND_FOR_EACH_PARALLEL
States that the activity is a forEach activity with parallel branches.
See Also:

KIND_SEQUENCE_END

  1. static final int KIND_SEQUENCE_END
Do not use - internal only.
See Also:

KIND_ERROR_INTERRUPTING_SUBPROCESS_START_EVENT

  1. static final int KIND_ERROR_INTERRUPTING_SUBPROCESS_START_EVENT
Do not use - internal only.
See Also:

KIND_SEQUENCE

  1. static final int KIND_SEQUENCE
Describes a sequence construct that contains activities to be performed sequentially.
See Also:

KIND_USER_TASK

  1. static final int KIND_USER_TASK
Do not use - internal only.
See Also:

KIND_TIMER_EVENT_SUBPROCESS_ACTIVITY

  1. static final int KIND_TIMER_EVENT_SUBPROCESS_ACTIVITY
Do not use - internal only.
See Also:

KIND_ABSTRACT_TASK

  1. static final int KIND_ABSTRACT_TASK
Do not use - internal only.
See Also:

KIND_MESSAGE_EVENT_SUBPROCESS_ACTIVITY

  1. static final int KIND_MESSAGE_EVENT_SUBPROCESS_ACTIVITY
Do not use - internal only.
See Also:

KIND_RECEIVE

  1. static final int KIND_RECEIVE
States that the activity is an activity that waits for input.
See Also:

KIND_ERROR_EVENT_SUBPROCESS_ACTIVITY

  1. static final int KIND_ERROR_EVENT_SUBPROCESS_ACTIVITY
Do not use - internal only.
See Also:

KIND_WHILE_END

  1. static final int KIND_WHILE_END
Do not use - internal only.
See Also:

KIND_TIMER_NONINTERRUPTING_SUBPROCESS_START_EVENT

  1. static final int KIND_TIMER_NONINTERRUPTING_SUBPROCESS_START_EVENT
Do not use - internal only.
See Also:

KIND_WHILE

  1. static final int KIND_WHILE
An activity that is repeated until a certain criteria is met.
See Also:

KIND_IOR_GATEWAY

  1. static final int KIND_IOR_GATEWAY
Do not use - internal only.
See Also:

KIND_COMPENSATION_THROW_EVENT

  1. static final int KIND_COMPENSATION_THROW_EVENT
Do not use - internal only.
See Also:

KIND_FOR_EACH_SERIAL_END

  1. static final int KIND_FOR_EACH_SERIAL_END
Do not use - internal only.
See Also:

KIND_FOR_EACH_SERIAL

  1. static final int KIND_FOR_EACH_SERIAL
States that the activity is a forEach activity with no parallel branches.
See Also:

KIND_COMPENSATION_INTERRUPTING_SUBPROCESS_START_EVENT

  1. static final int KIND_COMPENSATION_INTERRUPTING_SUBPROCESS_START_EVENT
Do not use - internal only.
See Also:

KIND_MESSAGE_END_EVENT

  1. static final int KIND_MESSAGE_END_EVENT
Do not use - internal only.
See Also:

KIND_ERROR_END_EVENT

  1. static final int KIND_ERROR_END_EVENT
Do not use - internal only.
See Also:

KIND_PARALLEL_GATEWAY

  1. static final int KIND_PARALLEL_GATEWAY
Do not use - internal only.
See Also:

KIND_NONE_END_EVENT

  1. static final int KIND_NONE_END_EVENT
Do not use - internal only.
See Also:

KIND_MESSAGE_START_EVENT

  1. static final int KIND_MESSAGE_START_EVENT
Do not use - internal only.
See Also:

KIND_SERVICE_TASK

  1. static final int KIND_SERVICE_TASK
Do not use - internal only.
See Also:

KIND_SWITCH_END

  1. static final int KIND_SWITCH_END
Do not use - internal only.
See Also:

KIND_MESSAGE_THROW_EVENT

  1. static final int KIND_MESSAGE_THROW_EVENT
Do not use - internal only.
See Also:

KIND_SWITCH

  1. static final int KIND_SWITCH
Describes a switch construct that allows to select an activity from a set of choices.
See Also:

KIND_TIMER_INTERRUPTING_BOUNDARY_EVENT

  1. static final int KIND_TIMER_INTERRUPTING_BOUNDARY_EVENT
Do not use - internal only.
See Also:

KIND_WAIT

  1. static final int KIND_WAIT
An activity that allows to wait for a given period of time.
See Also:

KIND_EMPTY

  1. 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:

KIND_COMPENSATE

  1. static final int KIND_COMPENSATE
States that the activity is a compensating activity.
See Also:

KIND_SCOPE_END

  1. static final int KIND_SCOPE_END
Do not use - internal only.
See Also:

KIND_RETHROW

  1. static final int KIND_RETHROW
States that the activity rethrows a fault.
See Also:

KIND_IOR_IN_GATEWAY

  1. static final int KIND_IOR_IN_GATEWAY
Do not use - internal only.
See Also:

KIND_EVENT_BASED_GATEWAY

  1. static final int KIND_EVENT_BASED_GATEWAY
Do not use - internal only.
See Also:

KIND_SCOPE

  1. static final int KIND_SCOPE
Describes a scope construct that allows for own variable definitions, fault and compensation handlers.
See Also:

KIND_RECEIVE_TASK

  1. static final int KIND_RECEIVE_TASK
Do not use - internal only.
See Also:

KIND_TERMINATE_END_EVENT

  1. static final int KIND_TERMINATE_END_EVENT
Do not use - internal only.
See Also:

KIND_SCRIPT_TASK

  1. static final int KIND_SCRIPT_TASK
Do not use - internal only.
See Also:

KIND_TIMER_CATCH_EVENT

  1. static final int KIND_TIMER_CATCH_EVENT
Do not use - internal only.
See Also:

KIND_MESSAGE_CATCH_EVENT

  1. static final int KIND_MESSAGE_CATCH_EVENT
Do not use - internal only.
See Also:

KIND_STAFF

  1. static final int KIND_STAFF
States that the activity involves people for its execution.
See Also:

KIND_SCRIPT

  1. static final int KIND_SCRIPT
States that the activity is implemented by plain Java code.
See Also:

KIND_TERMINATE

  1. static final int KIND_TERMINATE
States that the activity terminates execution.
See Also:

KIND_THROW

  1. static final int KIND_THROW
States that the activity throws a fault.
See Also:

KIND_COMPENSATION_END_EVENT

  1. static final int KIND_COMPENSATION_END_EVENT
Do not use - internal only.
See Also:

KIND_REPLY

  1. 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:

KIND_REPEAT_UNTIL_END

  1. static final int KIND_REPEAT_UNTIL_END
Do not use - internal only.
See Also:

KIND_MESSAGE_NONINTERRUPTING_SUBPROCESS_START_EVENT

  1. static final int KIND_MESSAGE_NONINTERRUPTING_SUBPROCESS_START_EVENT
Do not use - internal only.
See Also:

KIND_REPEAT_UNTIL

  1. static final int KIND_REPEAT_UNTIL
An activity that is repeated until an exit condition is met.
See Also:

KIND_CALL_ACTIVITY

  1. static final int KIND_CALL_ACTIVITY
Do not use - internal only.
See Also:

KIND_PICK_END

  1. static final int KIND_PICK_END
Do not use - internal only.
See Also:

KIND_PICK

  1. static final int KIND_PICK
States that the activity is an activity that waits for various input.
See Also:

KIND_SEND_TASK

  1. static final int KIND_SEND_TASK
Do not use - internal only.
See Also:

KIND_SUBPROCESS_ACTIVITY

  1. static final int KIND_SUBPROCESS_ACTIVITY
Do not use - internal only.
See Also:

KIND_FLOW_END

  1. static final int KIND_FLOW_END
Do not use - internal only.
See Also:

KIND_XOR_GATEWAY

  1. static final int KIND_XOR_GATEWAY
Do not use - internal only.
See Also:

KIND_COMPENSATE_SCOPE

  1. static final int KIND_COMPENSATE_SCOPE
States that the activity is a compensate scope activity.
See Also:

KIND_FLOW

  1. static final int KIND_FLOW
An activity that specifies one or more activities to be performed concurrently.
See Also:

KIND_ASSIGN

  1. static final int KIND_ASSIGN
States that the activity specifies some assignment.
See Also:

KIND_CUSTOM

  1. static final int KIND_CUSTOM
An activity that provides a plug-in mechanism for customer written implementations.
See Also:

KIND_INVOKE_END

  1. static final int KIND_INVOKE_END
Do not use - internal only.
See Also:

STOP_REASON_FOLLOW_ON_NAVIGATION_FAILED

  1. static final int STOP_REASON_FOLLOW_ON_NAVIGATION_FAILED
States that the follow on navigation of the activity failed.
See Also:

STOP_REASON_ACTIVATION_FAILED

  1. static final int STOP_REASON_ACTIVATION_FAILED
States that the activation of the activity failed.
See Also:

STOP_REASON_UNSPECIFIED

  1. static final int STOP_REASON_UNSPECIFIED
States that the activity is not stopped.
See Also:

STOP_REASON_EXIT_CONDITION_FALSE

  1. 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:

STOP_REASON_IMPLEMENTATION_FAILED

  1. static final int STOP_REASON_IMPLEMENTATION_FAILED
States that the implementation of the activity failed.
See Also:

INVOKED_INSTANCE_TYPE_CHILD_TASK

  1. static final int INVOKED_INSTANCE_TYPE_CHILD_TASK
States that the activity calls a stand-alone task that has "child" autonomy.
See Also:

INVOKED_INSTANCE_TYPE_NOT_SET

  1. 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:

INVOKED_INSTANCE_TYPE_INLINE_TASK

  1. static final int INVOKED_INSTANCE_TYPE_INLINE_TASK
States that the activity calls an inline human task.
See Also:

INVOKED_INSTANCE_TYPE_CHILD_PROCESS

  1. 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:

SUB_STATE_RESTARTING

  1. static final int SUB_STATE_RESTARTING
Do not use - internal only.
See Also:

SUB_STATE_FINISHING

  1. static final int SUB_STATE_FINISHING
Do not use - internal only.
See Also:

SUB_STATE_NONE

  1. static final int SUB_STATE_NONE
Do not use - internal only.
See Also:

SUB_STATE_FAILING

  1. static final int SUB_STATE_FAILING
Do not use - internal only.
See Also:

SUB_STATE_EXPIRING

  1. static final int SUB_STATE_EXPIRING
Do not use - internal only.
See Also:

SUB_STATE_SKIPPING

  1. static final int SUB_STATE_SKIPPING
Do not use - internal only.
See Also:

Method Detail

getID

  1. AIID getID()
Returns the object identifier.

getActivationTime

  1. java.util.Calendar getActivationTime( )
Returns the activation time of the activity instance.

getCompletionTime

  1. java.util.Calendar getCompletionTime( )
Returns the completion time of the activity instance. Returns null when the activity instance is not yet complete.

getLastModificationTime

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

getLastStateChangeTime

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

getName

  1. java.lang.String getName()
Returns the name of the activity instance. Returns null if there is no name.

getDisplayName

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

getDescription

  1. 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

  1. java.lang.String getOwner()
Returns the owner of the activity instance. Returns null when an owner is not assigned.

getStartTime

  1. java.util.Calendar getStartTime( )
Returns the start time of the activity instance. Returns null when the activity instance is not yet started.

getExecutionState

  1. 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

  1. java.util.Calendar getExpirationTime( )
Returns the time when the activity instance will expire or expired. Returns null when there is no expiration time.

getKind

  1. int getKind()
Returns the kind of the activity, for example, whether the activity is a pick or receive activity.

getUnhandledException

  1. ProcessException getUnhandledException( )
Returns the reason why the activity is in the Stopped execution state.

getStopReason

  1. 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

  1. PIID getProcessInstanceID()
Returns the object ID of the containing process instance.

getProcessTemplateID

  1. PTID getProcessTemplateID()
Returns the object ID of the process template that contains the activity definition.

getFaultNames

  1. java.util.List getFaultNames()
Returns the names of faults associated to the activity instance.

getInputMessageTypeName

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

  1. 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

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

getProcessAdministrators

  1. StaffResultSet getProcessAdministrators( )
  2. throws WorkItemManagerException
  3. InvalidLengthException
Returns the administrators of the process instance that contains the activity instance.
Throws:

getApplicationName

  1. java.lang.String getApplicationName( )
Returns the name of the enterprise application the activity belongs to.

getProcessTemplateName

  1. java.lang.String getProcessTemplateName( )
Returns the name of the first process template in the hierarchy that contains the activity definition.

getProcessInstanceName

  1. java.lang.String getProcessInstanceName( )
Returns the name of the process instance the activity belongs to.

isBusinessRelevant

  1. boolean isBusinessRelevant()
States whether the activity instance is a business relevant or an "auxiliary" step.

getTaskID

  1. 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

  1. TKIID getAdminTaskID()
Returns the ID of the associated administration task. Returns null if there is no administration task.

getProcessAdminTaskID

  1. TKIID getProcessAdminTaskID()
Returns the ID of the administration task associated to the containing process instance. Returns null if there is no administration task.

getScopeID

  1. com.ibm.bpe.api.SIID getScopeID( )
Returns the ID of the associated scope.
Since:
6.1.2.

getScopeTemplateID

  1. 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

  1. 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

  1. 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

  1. boolean isSkipRequested()
States whether the activity instance is to be skipped when reached during navigation.
Since:
6.1.2.

isContinueOnError

  1. 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

  1. ATID getActivityTemplateID()
Returns the object ID of the associated activity template.
Since:
6.2.

getInvokedInstanceID

  1. 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

  1. 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

  1. 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

  1. 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.