org.ow2.bonita.facade.runtime
Interface ActivityInst

All Superinterfaces:
Record, RuntimeRecord, java.io.Serializable

public interface ActivityInst
extends RuntimeRecord

Author:
Pierre Vigneras

Method Summary
 java.lang.String getFinishedBy()
          Returns the user finishing the activity.
 java.util.Date getFinishedDate()
          Returns the date recorded after the activity is finished.
 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.
 java.util.Map<java.lang.String,java.lang.Object> getVariablesAfterFinished()
          Returns all variables for the recorded activity after the activity has been finished.
 java.util.Map<java.lang.String,java.lang.Object> getVariablesAfterStarted()
          Returns all variables for the recorded activity after the activity has been started.
 java.util.Map<java.lang.String,java.lang.Object> getVariablesBeforeFinished()
          Returns all variables for the recorded activity before the activity has been finished.
 java.util.Map<java.lang.String,java.lang.Object> getVariablesBeforeStarted()
          Returns all variables for the recorded activity before the activity has been started.
 java.lang.Object getVariableValueAfterFinished(java.lang.String variableId)
          Returns the value of the variable with the specified key after the activity has been finished.
 java.lang.Object getVariableValueAfterStarted(java.lang.String variableId)
          Returns the value of the variable with the specified key after the activity has been started.
 java.lang.Object getVariableValueBeforeFinished(java.lang.String variableId)
          Returns the value of the variable with the specified key before the activity has been finished.
 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
getInstanceId, getProcessId
 
Methods inherited from interface org.ow2.bonita.facade.Record
getDeploymentId, getId, getPackageId
 

Method Detail

getStartedDate

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

Returns:
The date recorded after the activity is started.

getFinishedDate

java.util.Date getFinishedDate()
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.

getFinishedBy

java.lang.String getFinishedBy()
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 id 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 id.
Returns:
The value of the variable with the specified key.

getVariablesAfterStarted

java.util.Map<java.lang.String,java.lang.Object> getVariablesAfterStarted()
Returns all variables for the recorded activity after the activity has been started. At most 2 hooks (with OnReady, OnStart event name) have been executed if defined. The map returned by this method contains both global variables (for the process) and local variables (for this activity). Key is the variable id and value is the variable object. An empty map is returned if no variable is found.

Returns:
The map containing activity variables.

getVariableValueAfterStarted

java.lang.Object getVariableValueAfterStarted(java.lang.String variableId)
Returns the value of the variable with the specified key after the activity has been started. At most 2 hooks (with OnReady, OnStart event name) have been executed if defined.

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

getVariablesBeforeFinished

java.util.Map<java.lang.String,java.lang.Object> getVariablesBeforeFinished()
Returns all variables for the recorded activity before the activity has been finished. At most 2 hooks (with OnReady, OnStart event name) have been executed if defined. If the activity is implemented by a subflow, its execution is finished. The map returned by this method contains both global variables (for the process) and local variables (for this activity). Key is the variable id and value is the variable object. An empty map is returned if no variable is found.

Returns:
The map containing activity variables.

getVariableValueBeforeFinished

java.lang.Object getVariableValueBeforeFinished(java.lang.String variableId)
Returns the value of the variable with the specified key before the activity has been finished. At most 2 hooks (with OnReady, OnStart event name) have been executed if defined. If the activity is implemented by a subflow, its execution is finished.

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

getVariablesAfterFinished

java.util.Map<java.lang.String,java.lang.Object> getVariablesAfterFinished()
Returns all variables for the recorded activity after the activity has been finished. At most 3 hooks (with OnReady, OnStart, OnFinish event name) have been executed if defined. If the activity is implemented by a subflow, its execution is finished. The map returned by this method contains both global variables (for the process) and local variables (for this activity). Key is the variable id and value is the variable object. An empty map is returned if no variable is found.

Returns:
The map containing activity variables.

getVariableValueAfterFinished

java.lang.Object getVariableValueAfterFinished(java.lang.String variableId)
Returns the value of the variable with the specified key after the activity has been finished. At most 3 hooks (with OnReady, OnStart, OnFinish event name) have been executed if defined. If the activity is implemented by a subflow, its execution is finished.

Parameters:
variableId - the variable id.
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.