org.ow2.bonita.facade.runtime
Interface ProcessInst

All Superinterfaces:
RuntimeRecord, java.io.Serializable
All Known Subinterfaces:
ProcessFullInst

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 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.
 org.ow2.bonita.facade.uuid.ProcessInstanceUUID getParentInstanceUUID()
          If the instance is created to execute a subflow it returns the instance processDefinitionUUID 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.
 org.ow2.bonita.facade.uuid.ProcessInstanceUUID getUUID()
           
 
Methods inherited from interface org.ow2.bonita.facade.runtime.RuntimeRecord
getPackageDefinitionUUID, getProcessDefinitionUUID, getProcessInstanceUUID
 

Method Detail

getUUID

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

getParentInstanceUUID

org.ow2.bonita.facade.uuid.ProcessInstanceUUID getParentInstanceUUID()
If the instance is created to execute a subflow it returns the instance processDefinitionUUID of the instance creating this instance of subflow, otherwise it returns null.

Returns:
the processDefinitionUUID 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 processDefinitionUUID. 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 set at the end of the instance execution. Values remain null until the instance is not finished. Map Key is the variable processDefinitionUUID. 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 values set when the instance is getting finished.

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 processDefinitionUUID.
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 value of the variable with the specified key. This value is set at the end of the instance execution. Value remains null until the instance is not finished.

Parameters:
variableId - the variable processDefinitionUUID.
Returns:
the value of the variable with the specified key set when the instance is getting finished.

getInstanceState

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

Returns:
the instance state.