Package | Description |
---|---|
org.camunda.bpm.engine |
Public API of the Camunda Platform 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 Deployment sRuntimeService :
For starting and searching ProcessInstance sTaskService :
Exposes operations to manage human (standalone) Task s,
such as claiming, completing and assigning tasksIdentityService :
Used for managing User s,
Group s and the relations between themManagementService :
Exposes engine admin and maintenance operations,
which have no relation to the runtime execution of business processesHistoryService :
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.camunda.bpm.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
org.camunda.bpm.engine.impl.cmd | |
org.camunda.bpm.engine.rest.dto.runtime | |
org.camunda.bpm.engine.runtime |
Classes related to the
RuntimeService . |
org.camunda.bpm.qa.upgrade |
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 |
---|---|
Batch |
ManagementService.setJobRetriesAsync(JobQuery jobQuery,
int retries)
Sets the number of retries that jobs have left asynchronously.
|
Batch |
ManagementService.setJobRetriesAsync(List<String> jobIds,
JobQuery jobQuery,
int retries)
Sets the number of retries that jobs have left asynchronously.
|
Modifier and Type | Class and Description |
---|---|
class |
JobQueryImpl |
Modifier and Type | Method and Description |
---|---|
Batch |
ManagementServiceImpl.setJobRetriesAsync(JobQuery jobQuery,
int retries) |
Batch |
ManagementServiceImpl.setJobRetriesAsync(List<String> jobIds,
JobQuery jobQuery,
int retries) |
Modifier and Type | Field and Description |
---|---|
protected JobQuery |
SetJobsRetriesBatchCmd.jobQuery |
Constructor and Description |
---|
SetJobsRetriesBatchCmd(List<String> ids,
JobQuery jobQuery,
int retries) |
Modifier and Type | Method and Description |
---|---|
protected JobQuery |
JobQueryDto.createNewQuery(ProcessEngine engine) |
Modifier and Type | Method and Description |
---|---|
protected void |
JobQueryDto.applyFilters(JobQuery query) |
protected void |
JobQueryDto.applySortBy(JobQuery query,
String sortBy,
Map<String,Object> parameters,
ProcessEngine engine) |
Modifier and Type | Method and Description |
---|---|
JobQuery |
JobQuery.active()
Only select jobs that are not suspended.
|
JobQuery |
JobQuery.activityId(String activityId)
Only select jobs which are defined on an activity with the given id.
|
JobQuery |
JobQuery.createdAfter(Date date)
Only select jobs created after the given date.
|
JobQuery |
JobQuery.createdBefore(Date date)
Only select jobs created before the given date.
|
JobQuery |
JobQuery.duedateHigherThan(Date date)
Only select jobs where the duedate is higher then the given date.
|
JobQuery |
JobQuery.duedateHigherThen(Date date)
Deprecated.
|
JobQuery |
JobQuery.duedateHigherThenOrEquals(Date date)
Deprecated.
|
JobQuery |
JobQuery.duedateLowerThan(Date date)
Only select jobs where the duedate is lower than the given date.
|
JobQuery |
JobQuery.duedateLowerThen(Date date)
Deprecated.
|
JobQuery |
JobQuery.duedateLowerThenOrEquals(Date date)
Deprecated.
|
JobQuery |
JobQuery.exceptionMessage(String exceptionMessage)
Only select jobs that failed due to an exception with the given message.
|
JobQuery |
JobQuery.executable()
Only select jobs which are executable,
ie.
|
JobQuery |
JobQuery.executionId(String executionId)
Only select jobs which exist for the given execution
|
JobQuery |
JobQuery.failedActivityId(String activityId)
Only select jobs that failed due to an exception at an activity with the given id.
|
JobQuery |
JobQuery.includeJobsWithoutTenantId()
Select jobs which have no tenant id.
|
JobQuery |
JobQuery.jobDefinitionId(String jobDefinitionId)
Only select jobs which exist for the given job definition id.
|
JobQuery |
JobQuery.jobId(String jobId)
Only select jobs with the given id
|
JobQuery |
JobQuery.jobIds(Set<String> ids)
Only select jobs whose id is in the given set of ids
|
JobQuery |
JobQuery.messages()
Only select jobs that are messages.
|
JobQuery |
JobQuery.noRetriesLeft()
Only select jobs which have no retries left
|
JobQuery |
JobQuery.orderByExecutionId()
Order by execution id (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.orderByJobPriority()
Order by priority for execution (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.orderByProcessDefinitionId()
Order by process definition id (needs to be followed by
Query.asc() or Query.desc() ). |
JobQuery |
JobQuery.orderByProcessDefinitionKey()
Order by process definition key (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.priorityHigherThanOrEquals(long priority)
Only select jobs with a priority that is higher than or equal to the given priority.
|
JobQuery |
JobQuery.priorityLowerThanOrEquals(long priority)
Only select jobs with a priority that is lower than or equal to the given priority.
|
JobQuery |
JobQuery.processDefinitionId(String processDefinitionId)
Only select jobs which exist for the given process definition id.
|
JobQuery |
JobQuery.processDefinitionKey(String processDefinitionKey)
Only select jobs which exist for the given process definition key.
|
JobQuery |
JobQuery.processInstanceId(String processInstanceId)
Only select jobs which exist for the given process instance.
|
JobQuery |
JobQuery.processInstanceIds(Set<String> processInstanceIds)
Only select jobs which exist for any of the given process instance ids
|
JobQuery |
JobQuery.suspended()
Only select jobs that are suspended.
|
JobQuery |
JobQuery.tenantIdIn(String... tenantIds)
Only select jobs that belong to one of the given tenant ids.
|
JobQuery |
JobQuery.timers()
Only select jobs that are timers.
|
JobQuery |
JobQuery.withException()
Only select jobs that failed due to an exception.
|
JobQuery |
JobQuery.withoutTenantId()
Only select jobs which have no tenant id.
|
JobQuery |
JobQuery.withRetriesLeft()
Only select jobs which have retries left
|
Modifier and Type | Method and Description |
---|---|
JobQuery |
UpgradeTestRule.jobQuery() |
Copyright © 2022. All rights reserved.