org.ow2.bonita.facade.runtime
Interface ActivityInst<T extends ActivityBody>

All Superinterfaces:
RuntimeRecord, java.io.Serializable
All Known Subinterfaces:
ActivityFullInst<T>

public interface ActivityInst<T extends ActivityBody>
extends RuntimeRecord

Author:
Pierre Vigneras

Method Summary
 java.lang.String getActivityId()
           
 T getBody()
           
 java.lang.String getEndedBy()
          Returns the user finishing the activity.
 java.util.Date getEndedDate()
          Returns the date recorded after the activity is finished.
 java.lang.String getIterationId()
          Returns the iteration processDefinitionUUID of this activity
 java.util.Map<java.lang.String,java.lang.Object> getLastKnownVariableValues()
           
 java.lang.String getStartedBy()
          Returns the user starting the activity.
 java.util.Date getStartedDate()
          Returns the date recorded after the activity is started.
 org.ow2.bonita.util.Constants.ActivityState getState()
          Return the state of the recorded activity.
 org.ow2.bonita.facade.uuid.ActivityInstanceUUID getUUID()
           
 java.util.Map<java.lang.String,java.lang.Object> getVariablesBeforeStarted()
          Returns all variables for the recorded activity before the activity has been started.
 java.util.List<VariableUpdate> getVariableUpdates()
           
 java.lang.Object getVariableValueBeforeStarted(java.lang.String variableId)
          Returns the value of the variable with the specified key before the activity has been started.
 
Methods inherited from interface org.ow2.bonita.facade.runtime.RuntimeRecord
getPackageDefinitionUUID, getProcessDefinitionUUID, getProcessInstanceUUID
 

Method Detail

getUUID

org.ow2.bonita.facade.uuid.ActivityInstanceUUID getUUID()

getActivityId

java.lang.String getActivityId()

getIterationId

java.lang.String getIterationId()
Returns the iteration processDefinitionUUID of this activity


getStartedDate

java.util.Date getStartedDate()
Returns the date recorded after the activity is started.

Returns:
The date recorded after the activity is started.

getEndedDate

java.util.Date getEndedDate()
Returns the date recorded after the activity is finished.

Returns:
The date recorded after the activity is finished.

getStartedBy

java.lang.String getStartedBy()
Returns the user starting the activity.

Returns:
The user starting the activity.

getEndedBy

java.lang.String getEndedBy()
Returns the user finishing the activity.

Returns:
The user finishing the activity.

getVariablesBeforeStarted

java.util.Map<java.lang.String,java.lang.Object> getVariablesBeforeStarted()
Returns all variables for the recorded activity before the activity has been started. If a hook with an OnReady event name has been defined, this hook has been executed. The map returned by this method contains both global variables (for the process) and local variables (for this activity). Key is the variable processDefinitionUUID and value is the variable object. An empty map is returned if no variable is found.

Returns:
The map containing activity variables.

getVariableValueBeforeStarted

java.lang.Object getVariableValueBeforeStarted(java.lang.String variableId)
Returns the value of the variable with the specified key before the activity has been started. If a hook with an OnReady event name has been defined, this hook has been executed.

Parameters:
variableId - the variable processDefinitionUUID.
Returns:
The value of the variable with the specified key.

getState

org.ow2.bonita.util.Constants.ActivityState getState()
Return the state of the recorded activity.

Returns:
The state of the recorded activity.

getBody

T getBody()

getVariableUpdates

java.util.List<VariableUpdate> getVariableUpdates()

getLastKnownVariableValues

java.util.Map<java.lang.String,java.lang.Object> getLastKnownVariableValues()