org.jbpm.api
Interface HistoryService

public interface HistoryService

exposes the history information for ongoing and past process instances.

Author:

Tom Baeyens, Maciej Swiderski

Method Summary

java.util.Map<java.lang.String,java.lang.Number>	avgDurationPerActivity(java.lang.String processDefinitionId) returns the average duration in milliseconds for each activity in the given process definition
java.util.Map<java.lang.String,java.lang.Number>	choiceDistribution(java.lang.String processDefinitionId, java.lang.String activityName) returns for each transitionName, the number of times that transition was taken
HistoryActivityInstanceQuery	createHistoryActivityInstanceQuery() search in history activity instance information
HistoryDetailQuery	createHistoryDetailQuery() search in history details
HistoryProcessInstanceQuery	createHistoryProcessInstanceQuery() search for process instances in the history
HistoryTaskQuery	createHistoryTaskQuery() search in history task information
java.lang.Object	getVariable(java.lang.String processInstanceId, java.lang.String variableName) retrieves a map of variables
java.util.Set<java.lang.String>	getVariableNames(java.lang.String processInstanceId) retrieves a variable
java.util.Map<java.lang.String,?>	getVariables(java.lang.String processInstanceId, java.util.Set<java.lang.String> variableNames) all the variables visible in the given history execution scope

Method Detail

createHistoryProcessInstanceQuery

HistoryProcessInstanceQuery createHistoryProcessInstanceQuery()

search for process instances in the history

createHistoryActivityInstanceQuery

HistoryActivityInstanceQuery createHistoryActivityInstanceQuery()

search in history activity instance information

createHistoryTaskQuery

HistoryTaskQuery createHistoryTaskQuery()

search in history task information

createHistoryDetailQuery

HistoryDetailQuery createHistoryDetailQuery()

search in history details

avgDurationPerActivity

java.util.Map<java.lang.String,java.lang.Number> avgDurationPerActivity(java.lang.String processDefinitionId)

returns the average duration in milliseconds for each activity in the given process definition

choiceDistribution

java.util.Map<java.lang.String,java.lang.Number> choiceDistribution(java.lang.String processDefinitionId,
                                                                    java.lang.String activityName)

returns for each transitionName, the number of times that transition was taken

getVariableNames

java.util.Set<java.lang.String> getVariableNames(java.lang.String processInstanceId)

retrieves a variable

getVariable

java.lang.Object getVariable(java.lang.String processInstanceId,
                             java.lang.String variableName)

retrieves a map of variables

getVariables

java.util.Map<java.lang.String,?> getVariables(java.lang.String processInstanceId,
                                               java.util.Set<java.lang.String> variableNames)

all the variables visible in the given history execution scope