org.ow2.bonita.facade.runtime
Interface ProcessInst

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

public interface ProcessInst
extends RuntimeRecord

Author:
Pierre Vigneras

Method Summary
 java.lang.String getEndedBy()
          Returns the user finishing the instance of the workflow process.
 java.util.Date getEndedDate()
          Returns the date recorded when the instance is finished.
 java.lang.Object getInitialVariableValue(java.lang.String variableId)
          Returns the value of the variable with the specified key recorded at the instance creation.
 java.util.Map<java.lang.String,java.lang.Object> getInitialVariableValues()
          Returns all global variables (for the process instance) defined within the xml definition file and also optionally added as parameter (variable map) of the instantiateProcess() method.
 org.ow2.bonita.util.Constants.InstanceState getInstanceState()
          Returns the instance state.
 java.lang.Object getLastVariableValue(java.lang.String variableId)
          Returns the (last) current value of the variable with the specified key.
 java.util.Map<java.lang.String,java.lang.Object> getLastVariableValues()
          Returns all global variables (for the process instance) defined within the xml definition file and also optionally added as parameter (variables map) of the instantiateProcess() method.
 java.lang.String getParentInstanceId()
          If the instance is created to execute a subflow it returns the instance id of the instance creating this instance of subflow, otherwise it returns null.
 java.lang.String getStartedBy()
          Returns the user creating and starting the instance of the workflow process.
 java.util.Date getStartedDate()
          Returns the date recorded when the instance has been created and 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

getParentInstanceId

java.lang.String getParentInstanceId()
If the instance is created to execute a subflow it returns the instance id of the instance creating this instance of subflow, otherwise it returns null.

Returns:
the id of the parent instance (case of subflow) otherwise null.

getStartedDate

java.util.Date getStartedDate()
Returns the date recorded when the instance has been created and started.

Returns:
the date recorded when the instance has been created and started.

getEndedDate

java.util.Date getEndedDate()
Returns the date recorded when the instance is finished.

Returns:
the date recorded when the instance is finished.

getStartedBy

java.lang.String getStartedBy()
Returns the user creating and starting the instance of the workflow process.

Returns:
the user creating and starting the instance of the workflow process.

getEndedBy

java.lang.String getEndedBy()
Returns the user finishing the instance of the workflow process.

Returns:
the user finishing the instance of the workflow process.

getInitialVariableValues

java.util.Map<java.lang.String,java.lang.Object> getInitialVariableValues()
Returns all global variables (for the process instance) defined within the xml definition file and also optionally added as parameter (variable map) of the instantiateProcess() method. Variable values are ones recorded at instance creation. Map Key is the variable id. Map Object is the variable value. An empty map is returned if no variable is found.

Returns:
the map containing global (for process instance) variables recorded at instance creation

getLastVariableValues

java.util.Map<java.lang.String,java.lang.Object> getLastVariableValues()
Returns all global variables (for the process instance) defined within the xml definition file and also optionally added as parameter (variables map) of the instantiateProcess() method. Values are the (last) current variable values for the process instance. Map Key is the variable id. Map object is the variable value. An empty map is returned if no variable is found.

Returns:
the map containing global (for process instance) variables with (last) current values.

getInitialVariableValue

java.lang.Object getInitialVariableValue(java.lang.String variableId)
Returns the value of the variable with the specified key recorded at the instance creation.

Parameters:
variableId - the variable id.
Returns:
the value of the variable with the specified key recorded at the instance creation..

getLastVariableValue

java.lang.Object getLastVariableValue(java.lang.String variableId)
Returns the (last) current value of the variable with the specified key.

Parameters:
variableId - the variable id.
Returns:
the (last) value of the variable with the specified key.

getInstanceState

org.ow2.bonita.util.Constants.InstanceState getInstanceState()
Returns the instance state.

Returns:
the instance state.