|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ActivityInstanceData
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.
Field Summary | |
---|---|
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_ASSIGN
States that the activity specifies some assignment. |
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_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_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_IN_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_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_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_STAFF
States that the activity involves people for its execution. |
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_THROW
States that the activity throws a fault. |
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 |
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 | |
---|---|
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 |
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 |
---|
static final java.lang.String COPYRIGHT
static final int STATE_FINISHED
static final int STATE_PROCESSING_UNDO
static final int STATE_SKIPPED
static final int STATE_FAILED
static final int STATE_CLAIMED
static final int STATE_TERMINATING
static final int STATE_RUNNING
static final int STATE_TERMINATED
static final int STATE_READY
static final int STATE_FAILING
static final int STATE_EXPIRED
static final int STATE_INACTIVE
static final int STATE_STOPPED
static final int STATE_WAITING
static final int KIND_FOR_EACH_PARALLEL_END
static final int KIND_WAIT
static final int KIND_COMPENSATE
static final int KIND_EMPTY
static final int KIND_INVOKE
static final int KIND_FOR_EACH_PARALLEL
static final int KIND_SCOPE_END
static final int KIND_IOR_IN_GATEWAY
static final int KIND_RETHROW
static final int KIND_SEQUENCE_END
static final int KIND_SCOPE
static final int KIND_SEQUENCE
static final int KIND_STAFF
static final int KIND_TERMINATE
static final int KIND_SCRIPT
static final int KIND_RECEIVE
static final int KIND_THROW
static final int KIND_REPLY
static final int KIND_REPEAT_UNTIL_END
static final int KIND_WHILE_END
static final int KIND_REPEAT_UNTIL
static final int KIND_WHILE
static final int KIND_PICK_END
static final int KIND_PICK
static final int KIND_FOR_EACH_SERIAL_END
static final int KIND_FOR_EACH_SERIAL
static final int KIND_FLOW_END
static final int KIND_COMPENSATE_SCOPE
static final int KIND_FLOW
static final int KIND_ASSIGN
static final int KIND_SWITCH_END
static final int KIND_CUSTOM
static final int KIND_SWITCH
static final int KIND_INVOKE_END
static final int STOP_REASON_FOLLOW_ON_NAVIGATION_FAILED
static final int STOP_REASON_ACTIVATION_FAILED
static final int STOP_REASON_UNSPECIFIED
static final int STOP_REASON_EXIT_CONDITION_FALSE
static final int STOP_REASON_IMPLEMENTATION_FAILED
static final int INVOKED_INSTANCE_TYPE_CHILD_TASK
static final int INVOKED_INSTANCE_TYPE_NOT_SET
static final int INVOKED_INSTANCE_TYPE_INLINE_TASK
static final int INVOKED_INSTANCE_TYPE_CHILD_PROCESS
static final int SUB_STATE_RESTARTING
static final int SUB_STATE_FINISHING
static final int SUB_STATE_NONE
static final int SUB_STATE_FAILING
static final int SUB_STATE_EXPIRING
static final int SUB_STATE_SKIPPING
Method Detail |
---|
AIID getID()
java.util.Calendar getActivationTime()
java.util.Calendar getCompletionTime()
java.util.Calendar getLastModificationTime()
java.util.Calendar getLastStateChangeTime()
java.lang.String getName()
java.lang.String getDisplayName()
java.lang.String getDescription()
java.lang.String getOwner()
java.util.Calendar getStartTime()
int getExecutionState()
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.
java.util.Calendar getExpirationTime()
int getKind()
ProcessException getUnhandledException()
int getStopReason()
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.
PIID getProcessInstanceID()
PTID getProcessTemplateID()
java.util.List getFaultNames()
java.lang.String getInputMessageTypeName()
java.lang.String getInputMessageTypeTypeSystemName()
java.lang.String getOutputMessageTypeName()
java.lang.String getOutputMessageTypeTypeSystemName()
int[] getAvailableActions()
ActivityInstanceActions
for the
set of possible actions.
java.lang.String getCustomProperty(java.lang.String arg0)
arg0
- The name of the custom property for which the value is to be read.java.util.List getNamesOfCustomProperties()
StaffResultSet getProcessAdministrators() throws WorkItemManagerException, InvalidLengthException
WorkItemManagerException
InvalidLengthException
java.lang.String getApplicationName()
java.lang.String getProcessTemplateName()
java.lang.String getProcessInstanceName()
boolean isBusinessRelevant()
TKIID getTaskID()
TKIID getAdminTaskID()
TKIID getProcessAdminTaskID()
com.ibm.bpe.api.SIID getScopeID()
com.ibm.bpe.api.STID getScopeTemplateID()
com.ibm.bpe.api.EHIID getEventHandlerInstanceID()
com.ibm.bpe.api.FEIID getEnclosingForEachID()
boolean isSkipRequested()
boolean isContinueOnError()
This setting can be overwritten when calling
forceComplete
or
forceRetry
.
ATID getActivityTemplateID()
OID getInvokedInstanceID()
You can use
getInvokedInstanceType
to determine whether the object ID returned is a PIID or TKIID.
int getInvokedInstanceType()
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
.
int getSubState()
Possible values are: SUB_STATE_NONE, SUB_STATE_EXPIRING, SUB_STATE_SKIPPING, SUB_STATE_RESTARTING, SUB_STATE_FINISHING, SUB_STATE_FAILING.
java.util.Calendar getPreviousExpirationTime()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |