org.jbpm.api
Interface JobQuery


public interface JobQuery

query for jBPM related messages and timers.

Both messages and timers are jobs.

Author:
Tom Baeyens

Field Summary
static java.lang.String PROPERTY_DUEDATE
          duedate property to be used as property in orderAsc(String) and orderDesc(String)
static java.lang.String PROPERTY_STATE
          state property to be used as property in orderAsc(String) and orderDesc(String)
 
Method Summary
 long count()
          execute a count(*) query and returns number of results
 JobQuery exception(boolean hasException)
          only select jobs that were rolled back due to an exception
 java.util.List<Job> list()
          execute the query and get the result list
 JobQuery messages()
          only select messages
 JobQuery orderAsc(java.lang.String property)
          order ascending for property PROPERTY_STATE or PROPERTY_DUEDATE
 JobQuery orderDesc(java.lang.String property)
          order descending for property PROPERTY_STATE or PROPERTY_DUEDATE
 JobQuery page(int firstResult, int maxResults)
          only select a specific page
 JobQuery processInstanceId(java.lang.String processInstanceId)
          only select jobs related to the given process instance
 JobQuery timers()
          only select timers
 Job uniqueResult()
          execute the query and get the unique result
 

Field Detail

PROPERTY_DUEDATE

static final java.lang.String PROPERTY_DUEDATE
duedate property to be used as property in orderAsc(String) and orderDesc(String)

See Also:
Constant Field Values

PROPERTY_STATE

static final java.lang.String PROPERTY_STATE
state property to be used as property in orderAsc(String) and orderDesc(String)

See Also:
Constant Field Values
Method Detail

messages

JobQuery messages()
only select messages


timers

JobQuery timers()
only select timers


processInstanceId

JobQuery processInstanceId(java.lang.String processInstanceId)
only select jobs related to the given process instance


exception

JobQuery exception(boolean hasException)
only select jobs that were rolled back due to an exception


orderAsc

JobQuery orderAsc(java.lang.String property)
order ascending for property PROPERTY_STATE or PROPERTY_DUEDATE


orderDesc

JobQuery orderDesc(java.lang.String property)
order descending for property PROPERTY_STATE or PROPERTY_DUEDATE


page

JobQuery page(int firstResult,
              int maxResults)
only select a specific page


list

java.util.List<Job> list()
execute the query and get the result list


uniqueResult

Job uniqueResult()
execute the query and get the unique result


count

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



Copyright © 2010 JBoss Community. All Rights Reserved.