org.jbpm.api
Interface ProcessDefinitionQuery

public interface ProcessDefinitionQuery

query for process definitions.

Author:

Tom Baeyens

Field Summary

static java.lang.String	PROPERTY_DEPLOYMENT_TIMESTAMP timestamp property to be used as property in orderAsc(String) and orderDesc(String)
static java.lang.String	PROPERTY_ID id property to be used as property in orderAsc(String) and orderDesc(String)
static java.lang.String	PROPERTY_KEY key property to be used as property in orderAsc(String) and orderDesc(String)
static java.lang.String	PROPERTY_NAME name property to be used as property in orderAsc(String) and orderDesc(String)
static java.lang.String	PROPERTY_VERSION version 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
ProcessDefinitionQuery	deploymentId(java.lang.String deploymentId) select only process definitions within the given deployment
java.util.List<ProcessDefinition>	list() execute the query and obtain the list of ProcessDefinitions
ProcessDefinitionQuery	notSuspended() select only process definitions that are not suspended
ProcessDefinitionQuery	orderAsc(java.lang.String property) order selected process definitions ascending for certain properties
ProcessDefinitionQuery	orderDesc(java.lang.String property) order selected process definitions descending for certain properties
ProcessDefinitionQuery	page(int firstResult, int maxResults) select a specific page in the result set
ProcessDefinitionQuery	processDefinitionId(java.lang.String processDefinitionId) select only the process definition with the given id
ProcessDefinitionQuery	processDefinitionKey(java.lang.String key) select only process definitions with the given key
ProcessDefinitionQuery	processDefinitionName(java.lang.String name) select only process definitions with an exact match for the given name
ProcessDefinitionQuery	processDefinitionNameLike(java.lang.String name) select only process definitions with a name like the given name (name can include % signs to act as wildcard))
ProcessDefinitionQuery	suspended() select only suspended process definitions
ProcessDefinition	uniqueResult() execute the query and obtain the unique ProcessDefinition

Field Detail

PROPERTY_ID

static final java.lang.String PROPERTY_ID

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

See Also:

Constant Field Values

PROPERTY_KEY

static final java.lang.String PROPERTY_KEY

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

See Also:

Constant Field Values

PROPERTY_NAME

static final java.lang.String PROPERTY_NAME

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

See Also:

Constant Field Values

PROPERTY_VERSION

static final java.lang.String PROPERTY_VERSION

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

See Also:

Constant Field Values

PROPERTY_DEPLOYMENT_TIMESTAMP

static final java.lang.String PROPERTY_DEPLOYMENT_TIMESTAMP

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

See Also:

Constant Field Values

Method Detail

processDefinitionId

ProcessDefinitionQuery processDefinitionId(java.lang.String processDefinitionId)

select only the process definition with the given id

processDefinitionKey

ProcessDefinitionQuery processDefinitionKey(java.lang.String key)

select only process definitions with the given key

processDefinitionNameLike

ProcessDefinitionQuery processDefinitionNameLike(java.lang.String name)

select only process definitions with a name like the given name (name can include % signs to act as wildcard))

processDefinitionName

ProcessDefinitionQuery processDefinitionName(java.lang.String name)

select only process definitions with an exact match for the given name

deploymentId

ProcessDefinitionQuery deploymentId(java.lang.String deploymentId)

select only process definitions within the given deployment

suspended

ProcessDefinitionQuery suspended()

select only suspended process definitions

notSuspended

ProcessDefinitionQuery notSuspended()

select only process definitions that are not suspended

orderAsc

ProcessDefinitionQuery orderAsc(java.lang.String property)

order selected process definitions ascending for certain properties

orderDesc

ProcessDefinitionQuery orderDesc(java.lang.String property)

order selected process definitions descending for certain properties

page

ProcessDefinitionQuery page(int firstResult,
                            int maxResults)

select a specific page in the result set

list

java.util.List<ProcessDefinition> list()

execute the query and obtain the list of ProcessDefinitions

uniqueResult

ProcessDefinition uniqueResult()

execute the query and obtain the unique ProcessDefinition

count

long count()

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