org.jbpm.api.history
Interface HistoryProcessInstance

public interface HistoryProcessInstance

one particular instance of a process definition. Every ProcessInstance will have one HistoryProcessInstance associated. The difference is that the ProcessInstance will be deleted when it is ended, whereas the history information will remain in the DB. That keeps the runtime DB healthy and performing well.

Author:

Tom Baeyens

Field Summary

static java.lang.String	STATE_ACTIVE when the full process instance is still active
static java.lang.String	STATE_ENDED when the full process instance has come to an end

Method Summary

java.lang.Long	getDuration() duration of the process instance in milliseconds or null if the process instance has not yet ended
java.lang.String	getEndActivityName() Returns the name of the end state that was reached when the process was ended.
java.util.Date	getEndTime() when the process instance ended (only not null if the process instance already ended)
java.lang.String	getKey() unique user provided business key (could be null if no such key is provided in ExecutionService.startProcessInstanceById(String, java.util.Map, String))
java.lang.String	getProcessDefinitionId() reference to the process definition
java.lang.String	getProcessInstanceId() the process instance id (== the root execution id)
java.util.Date	getStartTime() when the process instance started
java.lang.String	getState() STATE_ACTIVE or STATE_ENDED (this more coarse grained state then Execution.getState())

Field Detail

STATE_ENDED

static final java.lang.String STATE_ENDED

when the full process instance has come to an end

See Also:

Constant Field Values

STATE_ACTIVE

static final java.lang.String STATE_ACTIVE

when the full process instance is still active

See Also:

Constant Field Values

Method Detail

getProcessInstanceId

java.lang.String getProcessInstanceId()

the process instance id (== the root execution id)

getProcessDefinitionId

java.lang.String getProcessDefinitionId()

reference to the process definition

getKey

java.lang.String getKey()

unique user provided business key (could be null if no such key is provided in ExecutionService.startProcessInstanceById(String, java.util.Map, String))

getState

java.lang.String getState()

STATE_ACTIVE or STATE_ENDED (this more coarse grained state then Execution.getState())

getStartTime

java.util.Date getStartTime()

when the process instance started

getEndTime

java.util.Date getEndTime()

when the process instance ended (only not null if the process instance already ended)

getDuration

java.lang.Long getDuration()

duration of the process instance in milliseconds or null if the process instance has not yet ended

getEndActivityName

java.lang.String getEndActivityName()

Returns the name of the end state that was reached when the process was ended.