com.ibm.bpe.api
Interface ActivityInstanceData

All Superinterfaces:
java.io.Serializable

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 staff, receive, or pick activity, the staff assignment is resolved and work items are created so that the staff 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:
6.0 - introduced in 5.0

Field Summary
static java.lang.String COPYRIGHT
           
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_CUSTOM
          An activity that provides a plug-in mechanismn 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
          For future use.
static int KIND_INVOKE
          States that the activity describes some external service to be invoked.
static int KIND_INVOKE_END
          For future use.
static int KIND_PICK
          States that the activity is an activity that waits for various input.
static int KIND_PICK_END
          For future use.
static int KIND_RECEIVE
          States that the activity is an activity that waits for input.
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
          For future use.
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
          For future use.
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
          For future use.
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
          For future use.
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.
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.
 
Method Summary
 java.util.Calendar getActivationTime()
          Returns the activation time of the activity instance.
 com.ibm.task.api.TKIID getAdminTaskID()
          Returns the ID of the associated administrative 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.
 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.  
 int getKind()
          Returns the kind of the 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.  
 java.lang.String getOwner()
          Returns the owner of the activity instance.
 StaffResultSet getProcessAdministrators()
          Returns the process administrators.
 PIID getProcessInstanceID()
          Returns the object ID of the first containing process instance in the hierarchy that is not a block.
 java.lang.String getProcessInstanceName()
          Returns the name of the process instance the activity belongs to.
 PTID getProcessTemplateID()
          Returns the object ID of the first process template in the hierarchy that is not a block and 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.
 java.util.Calendar getStartTime()
          Returns the start time of the activity instance.
 com.ibm.task.api.TKIID getTaskID()
          Returns the ID of the associated participating task, if any.
 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.
 

Field Detail

COPYRIGHT

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

STATE_TERMINATED

public static final int STATE_TERMINATED
States that the activity has been terminated because of an external or internal request.

See Also:
Constant Field Values

STATE_READY

public static final int STATE_READY
States that the activity is ready to be started.

See Also:
Constant Field Values

STATE_EXPIRED

public static final int STATE_EXPIRED
States that the activity ended because its allowed duration timed-out.

See Also:
Constant Field Values

STATE_CLAIMED

public static final int STATE_CLAIMED
States that the activity has been claimed.

See Also:
Constant Field Values

STATE_INACTIVE

public static final int STATE_INACTIVE
States that the activity has not yet been scheduled for execution.

See Also:
Constant Field Values

STATE_PROCESSING_UNDO

public 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

public 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

public static final int STATE_FAILED
States that the activity failed to execute.

See Also:
Constant Field Values

STATE_STOPPED

public 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

STATE_RUNNING

public static final int STATE_RUNNING
States that the activity is running.

See Also:
Constant Field Values

STATE_FINISHED

public static final int STATE_FINISHED
States that the activity finished execution successfully.

See Also:
Constant Field Values

STATE_FAILING

public 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_WAITING

public 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_TERMINATING

public 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

KIND_EMPTY

public 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_THROW

public static final int KIND_THROW
States that the activity throws a fault.

See Also:
Constant Field Values

KIND_FLOW

public static final int KIND_FLOW
An activity that specifies one or more activities to be performed concurrently.

See Also:
Constant Field Values

KIND_INVOKE_END

public static final int KIND_INVOKE_END
For future use.

See Also:
Constant Field Values

KIND_INVOKE

public static final int KIND_INVOKE
States that the activity describes some external service to be invoked.

See Also:
Constant Field Values

KIND_PICK

public static final int KIND_PICK
States that the activity is an activity that waits for various input.

See Also:
Constant Field Values

KIND_STAFF

public static final int KIND_STAFF
States that the activity involves people for its execution.

See Also:
Constant Field Values

KIND_SEQUENCE_END

public static final int KIND_SEQUENCE_END
For future use.

See Also:
Constant Field Values

KIND_WHILE

public static final int KIND_WHILE
An activity that is repeated until a certain criteria is met.

See Also:
Constant Field Values

KIND_PICK_END

public static final int KIND_PICK_END
For future use.

See Also:
Constant Field Values

KIND_FLOW_END

public static final int KIND_FLOW_END
For future use.

See Also:
Constant Field Values

KIND_SWITCH_END

public static final int KIND_SWITCH_END
For future use.

See Also:
Constant Field Values

KIND_SCRIPT

public static final int KIND_SCRIPT
States that the activity is implemented by plain Java code.

See Also:
Constant Field Values

KIND_REPLY

public 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_SWITCH

public 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_SEQUENCE

public static final int KIND_SEQUENCE
Describes a sequence construct that contains activities to be performed sequentially.

See Also:
Constant Field Values

KIND_WAIT

public static final int KIND_WAIT
An activity that allows to wait for a given period of time.

See Also:
Constant Field Values

KIND_WHILE_END

public static final int KIND_WHILE_END
For future use.

See Also:
Constant Field Values

KIND_RETHROW

public static final int KIND_RETHROW
States that the activity rethrows a fault.

See Also:
Constant Field Values

KIND_RECEIVE

public static final int KIND_RECEIVE
States that the activity is an activity that waits for input.

See Also:
Constant Field Values

KIND_COMPENSATE

public static final int KIND_COMPENSATE
States that the activity is a compensating activity.

See Also:
Constant Field Values

KIND_SCOPE

public 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_SCOPE_END

public static final int KIND_SCOPE_END
For future use.

See Also:
Constant Field Values

KIND_TERMINATE

public static final int KIND_TERMINATE
States that the activity terminates execution.

See Also:
Constant Field Values

KIND_CUSTOM

public static final int KIND_CUSTOM
An activity that provides a plug-in mechanismn for customer written implementations.

See Also:
Constant Field Values

KIND_ASSIGN

public static final int KIND_ASSIGN
States that the activity specifies some assignment.

See Also:
Constant Field Values
Method Detail

getID

public AIID getID()
Returns the object identifier.


getActivationTime

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


getCompletionTime

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


getLastModificationTime

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


getLastStateChangeTime

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


getName

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


getDisplayName

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


getDescription

public 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

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


getStartTime

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


getExecutionState

public 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

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


getKind

public int getKind()
Returns the kind of the activity.

Possible values are: KIND_EMPTY, KIND_FAULT, KIND_SINK, KIND_SOURCE, KIND_ELEMENTAL, KIND_EVENT, KIND_PROCESS_BLOCK, KIND_PROCESS_SUBPROCESS, KIND_PERSON, KIND_INVOKE, KIND_INVOKE_END, KIND_RECEIVE, KIND_REPLY, KIND_THROW, KIND_TERMINATE, KIND_WAIT, KIND_COMPENSATE, KIND_SEQUENCE, KIND_SEQUENCE_END, KIND_SWITCH, KIND_SWITCH_END, KIND_WHILE, KIND_WHILE_END, KIND_PICK, KIND_PICK_END, KIND_FLOW, KIND_FLOW_END, KIND_SCOPE, KIND_SCOPE_END, KIND_SCRIPT,KIND_STAFF, KIND_ASSIGN, KIND_CUSTOM, KIND_RETHROW.


getUnhandledException

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


getProcessInstanceID

public PIID getProcessInstanceID()
Returns the object ID of the first containing process instance in the hierarchy that is not a block.


getProcessTemplateID

public PTID getProcessTemplateID()
Returns the object ID of the first process template in the hierarchy that is not a block and that contains the activity definition.


getFaultNames

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


getInputMessageTypeName

public 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

public java.lang.String getInputMessageTypeTypeSystemName()
Deprecated.  

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

public 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

public java.lang.String getOutputMessageTypeTypeSystemName()
Deprecated.  

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

public 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

public java.lang.String getCustomProperty(java.lang.String arg0)
Returns the value of the specified custom property. Returns a null object 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

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


getProcessAdministrators

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

Throws:
WorkItemManagerException
InvalidLengthException

getApplicationName

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


getProcessTemplateName

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


getProcessInstanceName

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


isBusinessRelevant

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


getTaskID

public com.ibm.task.api.TKIID getTaskID()
Returns the ID of the associated participating task, if any.


getAdminTaskID

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