org.jbpm.api.history
Interface HistoryActivityInstanceQuery

public interface HistoryActivityInstanceQuery

query for activity occurrences.

Author:

Tom Baeyens

Field Summary

static java.lang.String	PROPERTY_ACTIVITYNAME activityName property to be used as property in orderAsc(String) and orderDesc(String)
static java.lang.String	PROPERTY_DURATION duration property to be used as property in orderAsc(String) and orderDesc(String)
static java.lang.String	PROPERTY_ENDTIME endtime property to be used as property in orderAsc(String) and orderDesc(String)
static java.lang.String	PROPERTY_EXECUTIONID executionId property to be used as property in orderAsc(String) and orderDesc(String)
static java.lang.String	PROPERTY_STARTTIME starttime property to be used as property in orderAsc(String) and orderDesc(String)

Method Summary

HistoryActivityInstanceQuery	activityName(java.lang.String activityName) only select activity instances for the given activity (this usually used in combination with processDefinitionId(String))
long	count() execute a count(*) query and returns number of results
HistoryActivityInstanceQuery	executionId(java.lang.String executionId) only select activity instances for the given execution
java.util.List<HistoryActivityInstance>	list() execute the query and obtain the list of HistoryActivityInstances
HistoryActivityInstanceQuery	orderAsc(java.lang.String property) order selected activity instances ascending for certain properties
HistoryActivityInstanceQuery	orderDesc(java.lang.String property) order selected process definitions descending for certain properties
HistoryActivityInstanceQuery	page(int firstResult, int maxResults) select a specific page in the result set
HistoryActivityInstanceQuery	processDefinitionId(java.lang.String processDefinitionId) only select activity instances for the given process definition
HistoryActivityInstanceQuery	startedAfter(java.util.Date time) only select activity instances started after the given time
HistoryActivityInstanceQuery	startedBefore(java.util.Date time) only select activity instances started before the given time
HistoryActivityInstanceQuery	tookLessThen(long durationInMillis) only select activity instances that took less then the given duration in milliseconds
HistoryActivityInstanceQuery	tookLongerThen(long durationInMillis) only select activity instances that took longer then the given duration in milliseconds
HistoryActivityInstance	uniqueResult() execute the query and obtain the unique HistoryActivityInstance

Field Detail

PROPERTY_STARTTIME

static final java.lang.String PROPERTY_STARTTIME

starttime property to be used as property in orderAsc(String) and orderDesc(String)

See Also:

Constant Field Values

PROPERTY_ENDTIME

static final java.lang.String PROPERTY_ENDTIME

endtime property to be used as property in orderAsc(String) and orderDesc(String)

See Also:

Constant Field Values

PROPERTY_EXECUTIONID

static final java.lang.String PROPERTY_EXECUTIONID

executionId property to be used as property in orderAsc(String) and orderDesc(String)

See Also:

Constant Field Values

PROPERTY_ACTIVITYNAME

static final java.lang.String PROPERTY_ACTIVITYNAME

activityName property to be used as property in orderAsc(String) and orderDesc(String)

See Also:

Constant Field Values

PROPERTY_DURATION

static final java.lang.String PROPERTY_DURATION

duration property to be used as property in orderAsc(String) and orderDesc(String)

See Also:

Constant Field Values

Method Detail

processDefinitionId

HistoryActivityInstanceQuery processDefinitionId(java.lang.String processDefinitionId)

only select activity instances for the given process definition

executionId

HistoryActivityInstanceQuery executionId(java.lang.String executionId)

only select activity instances for the given execution

startedAfter

HistoryActivityInstanceQuery startedAfter(java.util.Date time)

only select activity instances started after the given time

startedBefore

HistoryActivityInstanceQuery startedBefore(java.util.Date time)

only select activity instances started before the given time

activityName

HistoryActivityInstanceQuery activityName(java.lang.String activityName)

only select activity instances for the given activity (this usually used in combination with processDefinitionId(String))

tookLongerThen

HistoryActivityInstanceQuery tookLongerThen(long durationInMillis)

only select activity instances that took longer then the given duration in milliseconds

tookLessThen

HistoryActivityInstanceQuery tookLessThen(long durationInMillis)

only select activity instances that took less then the given duration in milliseconds

orderAsc

HistoryActivityInstanceQuery orderAsc(java.lang.String property)

order selected activity instances ascending for certain properties

orderDesc

HistoryActivityInstanceQuery orderDesc(java.lang.String property)

order selected process definitions descending for certain properties

page

HistoryActivityInstanceQuery page(int firstResult,
                                  int maxResults)

select a specific page in the result set

list

java.util.List<HistoryActivityInstance> list()

execute the query and obtain the list of HistoryActivityInstances

uniqueResult

HistoryActivityInstance uniqueResult()

execute the query and obtain the unique HistoryActivityInstance

count

long count()

execute a count(*) query and returns number of results