| Package | Description |
|---|---|
| org.flowable.cmmn.api | |
| org.flowable.cmmn.engine.impl | |
| org.flowable.cmmn.rest.service.api | |
| org.flowable.engine |
Public API of the Flowable engine.
Typical usage of the API starts by the creation of a ProcessEngineConfiguration
(typically based on a configuration file), from which a ProcessEngine can be obtained.Through the services obtained from such a ProcessEngine, BPM and workflow operation
can be executed:RepositoryService: Manages Deployments.RuntimeService: For starting and searching ProcessInstances.TaskService: Exposes operations to manage human (standalone) tasks, such as claiming, completing and assigning tasks.IdentityService: Used for managing users, groups and the relations between them.ManagementService: Exposes engine administration and maintenance operations,
which have no relation to the runtime exection of business processes.HistoryService: Exposes information about ongoing and past process instances.FormService: Access to form data and rendered forms for starting new process instances and completing tasks. |
| org.flowable.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.flowable.job.api | |
| org.flowable.job.service | |
| org.flowable.job.service.impl | |
| org.flowable.rest.service.api |
| Modifier and Type | Method and Description |
|---|---|
JobQuery |
CmmnManagementService.createJobQuery()
Returns a new JobQuery implementation, that can be used to query the jobs.
|
| Modifier and Type | Method and Description |
|---|---|
JobQuery |
CmmnManagementServiceImpl.createJobQuery() |
| Modifier and Type | Method and Description |
|---|---|
void |
CmmnRestApiInterceptor.accessJobInfoWithQuery(JobQuery jobQuery) |
| Modifier and Type | Method and Description |
|---|---|
JobQuery |
ManagementService.createJobQuery()
Returns a new JobQuery implementation, that can be used to dynamically query the jobs.
|
| Modifier and Type | Method and Description |
|---|---|
JobQuery |
ManagementServiceImpl.createJobQuery() |
| Modifier and Type | Method and Description |
|---|---|
JobQuery |
JobQuery.caseDefinitionId(String caseDefinitionId)
Only select jobs for the given case definition.
|
JobQuery |
JobQuery.caseInstanceId(String caseInstanceId)
Only select jobs for the given case instance.
|
JobQuery |
JobQuery.category(String category)
Only select jobs which exist for the given category
|
JobQuery |
JobQuery.categoryLike(String categoryLike)
Only select jobs like for the given category value
|
JobQuery |
JobQuery.correlationId(String correlationId)
Only select jobs with the given correlationId.
|
JobQuery |
JobQuery.duedateHigherThan(Date date)
Only select jobs where the duedate is higher then the given date.
|
JobQuery |
JobQuery.duedateLowerThan(Date date)
Only select jobs where the duedate is lower than the given date.
|
JobQuery |
JobQuery.elementId(String elementId)
Only select jobs which exist for the given element id
|
JobQuery |
JobQuery.elementName(String elementName)
Only select jobs which exist for the given element name
|
JobQuery |
JobQuery.exceptionMessage(String exceptionMessage)
Only select jobs that failed due to an exception with the given message.
|
JobQuery |
JobQuery.executionId(String executionId)
Only select jobs which exist for the given execution
|
JobQuery |
JobQuery.handlerType(String handlerType)
Select jobs which have given job handler type
|
JobQuery |
JobQuery.jobId(String jobId)
Only select jobs with the given id
|
JobQuery |
JobQuery.jobTenantId(String tenantId)
Only select jobs that have the given tenant id.
|
JobQuery |
JobQuery.jobTenantIdLike(String tenantIdLike)
Only select jobs with a tenant id like the given one.
|
JobQuery |
JobQuery.jobWithoutTenantId()
Only select jobs that do not have a tenant id.
|
JobQuery |
JobQuery.locked()
Only return jobs that are locked (i.e.
|
JobQuery |
JobQuery.lockOwner(String lockOwner)
Only return jobs with the given lock owner.
|
JobQuery |
JobQuery.messages()
Only select jobs that are messages.
|
JobQuery |
JobQuery.orderByExecutionId()
Order by execution id (needs to be followed by
Query.asc() or Query.desc()). |
JobQuery |
JobQuery.orderByJobCreateTime()
Order by create time (needs to be followed by
Query.asc() or Query.desc()). |
JobQuery |
JobQuery.orderByJobDuedate()
Order by duedate (needs to be followed by
Query.asc() or Query.desc()). |
JobQuery |
JobQuery.orderByJobId()
Order by job id (needs to be followed by
Query.asc() or Query.desc()). |
JobQuery |
JobQuery.orderByJobRetries()
Order by retries (needs to be followed by
Query.asc() or Query.desc()). |
JobQuery |
JobQuery.orderByProcessInstanceId()
Order by process instance id (needs to be followed by
Query.asc() or Query.desc()). |
JobQuery |
JobQuery.orderByTenantId()
Order by tenant id (needs to be followed by
Query.asc() or Query.desc()). |
JobQuery |
JobQuery.planItemInstanceId(String planItemInstanceId)
Only select jobs for the given plan item instance.
|
JobQuery |
JobQuery.processDefinitionId(String processDefinitionId)
Only select jobs which exist for the given process definition id
|
JobQuery |
JobQuery.processInstanceId(String processInstanceId)
Only select jobs which exist for the given process instance.
|
JobQuery |
JobQuery.scopeDefinitionId(String scopeDefinitionId)
Only select tasks for the given scope definition identifier.
|
JobQuery |
JobQuery.scopeId(String scopeId)
Only select tasks for the given scope identifier.
|
JobQuery |
JobQuery.scopeType(String scopeType)
Only select tasks for the given scope type.
|
JobQuery |
JobQuery.subScopeId(String subScopeId)
Only select tasks for the given sub scope identifier.
|
JobQuery |
JobQuery.timers()
Only select jobs that are timers.
|
JobQuery |
JobQuery.unlocked()
Only return jobs that are not locked.
|
JobQuery |
JobQuery.withException()
Only select jobs that failed due to an exception.
|
JobQuery |
JobQuery.withoutScopeType()
Only return jobs that do not have a scope type.
|
| Modifier and Type | Method and Description |
|---|---|
JobQuery |
JobService.createJobQuery() |
| Modifier and Type | Class and Description |
|---|---|
class |
JobQueryImpl |
| Modifier and Type | Method and Description |
|---|---|
void |
BpmnRestApiInterceptor.accessJobInfoWithQuery(JobQuery jobQuery) |
Copyright © 2023 Flowable. All rights reserved.