org.jbpm.api.history
Interface HistoryDetailQuery

public interface HistoryDetailQuery

query for task comments, task assignments and so on.

Author:

Tom Baeyens

Field Summary

static java.lang.String	PROPERTY_TIME time property to be used as property in orderAsc(String) and orderDesc(String)
static java.lang.String	PROPERTY_USERID userId property to be used as property in orderAsc(String) and orderDesc(String)

Method Summary

HistoryDetailQuery	activityInstanceId(java.lang.String activityInstanceId) only select details for the given activityInstanceId
HistoryDetailQuery	comments() only select details of type comment (this usually used in combination with #processDefinitionId(String))
long	count() execute a count(*) query and returns number of results
java.util.List<HistoryDetail>	list() execute the query and obtain the list of HistoryDetails
HistoryDetailQuery	orderAsc(java.lang.String property) order selected process definitions ascending
HistoryDetailQuery	orderDesc(java.lang.String property) order selected process definitions descending
HistoryDetailQuery	page(int firstResult, int maxResults) select a specific page in the result set
HistoryDetailQuery	processInstanceId(java.lang.String processInstanceId) only select details for the given processInstanceId
HistoryDetailQuery	taskId(java.lang.String taskId) only select details for the given taskId
HistoryDetailQuery	timeAfter(java.util.Date time) only select details after the given time
HistoryDetailQuery	timeBefore(java.util.Date time) only select details before the given time
HistoryDetail	uniqueResult() execute the query and obtain the unique HistoryDetail

Field Detail

PROPERTY_USERID

static final java.lang.String PROPERTY_USERID

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

See Also:

Constant Field Values

PROPERTY_TIME

static final java.lang.String PROPERTY_TIME

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

See Also:

Constant Field Values

Method Detail

processInstanceId

HistoryDetailQuery processInstanceId(java.lang.String processInstanceId)

only select details for the given processInstanceId

activityInstanceId

HistoryDetailQuery activityInstanceId(java.lang.String activityInstanceId)

only select details for the given activityInstanceId

taskId

HistoryDetailQuery taskId(java.lang.String taskId)

only select details for the given taskId

timeAfter

HistoryDetailQuery timeAfter(java.util.Date time)

only select details after the given time

timeBefore

HistoryDetailQuery timeBefore(java.util.Date time)

only select details before the given time

comments

HistoryDetailQuery comments()

only select details of type comment (this usually used in combination with #processDefinitionId(String))

orderAsc

HistoryDetailQuery orderAsc(java.lang.String property)

order selected process definitions ascending

orderDesc

HistoryDetailQuery orderDesc(java.lang.String property)

order selected process definitions descending

page

HistoryDetailQuery page(int firstResult,
                        int maxResults)

select a specific page in the result set

list

java.util.List<HistoryDetail> list()

execute the query and obtain the list of HistoryDetails

uniqueResult

HistoryDetail uniqueResult()

execute the query and obtain the unique HistoryDetail

count

long count()

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