A B C D E F G H I J L M N O P R S T U W

A

acquireAndLock(int, String) - Method in interface org.flowable.job.api.ExternalWorkerJobAcquireBuilder

Acquire and lock the given number of jobs for the given worker id.

acquireAndLock(int, String, int) - Method in interface org.flowable.job.api.ExternalWorkerJobAcquireBuilder

Acquire and lock the given number of jobs for the given worker id.

AcquiredExternalWorkerJob - Interface in org.flowable.job.api

B

BaseJobQuery<U extends BaseJobQuery<U,T>,T extends Job> - Interface in org.flowable.job.api

Allows programmatic querying of Jobs.

C

caseDefinitionId(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs for the given case definition.

caseInstanceId(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs for the given case instance.

category(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs which exist for the given category

categoryLike(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs like for the given category value

correlationId(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs with the given correlationId.

D

DeadLetterJobQuery - Interface in org.flowable.job.api

Allows programmatic querying of Jobs.

DEFAULT_EXCLUSIVE - Static variable in interface org.flowable.job.api.Job

duedateHigherThan(Date) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs where the duedate is higher then the given date.

duedateLowerThan(Date) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs where the duedate is lower than the given date.

E

elementId(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs which exist for the given element id

elementName(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs which exist for the given element name

errorDetails(String) - Method in interface org.flowable.job.api.ExternalWorkerJobFailureBuilder

The longer error details for the failing job.

errorMessage(String) - Method in interface org.flowable.job.api.ExternalWorkerJobFailureBuilder

The error message for the failing job.

exceptionMessage(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs that failed due to an exception with the given message.

exceptionMessage(String) - Method in interface org.flowable.job.api.HistoryJobQuery

Only select jobs that failed due to an exception with the given message.

executable() - Method in interface org.flowable.job.api.DeadLetterJobQuery

Only select jobs which are executable, ie.

executable() - Method in interface org.flowable.job.api.SuspendedJobQuery

Only select jobs which are executable, ie.

executable() - Method in interface org.flowable.job.api.TimerJobQuery

Only select jobs which are executable, ie.

executionId(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs which exist for the given execution

ExternalWorkerJob - Interface in org.flowable.job.api

ExternalWorkerJobAcquireBuilder - Interface in org.flowable.job.api

ExternalWorkerJobFailureBuilder - Interface in org.flowable.job.api

ExternalWorkerJobQuery - Interface in org.flowable.job.api

Allows programmatic querying of External Worker Jobs.

externalWorkers() - Method in interface org.flowable.job.api.DeadLetterJobQuery

Only select external worker jobs.

externalWorkers() - Method in interface org.flowable.job.api.SuspendedJobQuery

Only select external worker jobs.

F

fail() - Method in interface org.flowable.job.api.ExternalWorkerJobFailureBuilder

Perform the logic for failing a job.

forUserOrGroups(String, Collection<String>) - Method in interface org.flowable.job.api.ExternalWorkerJobAcquireBuilder

Acquire only jobs where the given user or groups are authorized to execute.

forUserOrGroups(String, Collection<String>) - Method in interface org.flowable.job.api.ExternalWorkerJobQuery

Only select jobs for the given user or groups.

G

getCategory() - Method in interface org.flowable.job.api.Job

Get the category for this job.

getCorrelationId() - Method in interface org.flowable.job.api.Job

Returns the correlation id of a job.

getCreateTime() - Method in interface org.flowable.job.api.HistoryJob

Get the job create time.

getCreateTime() - Method in interface org.flowable.job.api.Job

Returns the create datetime of the job.

getCustomValues() - Method in interface org.flowable.job.api.JobInfo

Get the custom values.

getDuedate() - Method in interface org.flowable.job.api.Job

Returns the date on which this job is supposed to be processed.

getElementId() - Method in interface org.flowable.job.api.Job

Reference to an element identifier or null if none is set.

getElementName() - Method in interface org.flowable.job.api.Job

Reference to an element name or null if none is set.

getExceptionMessage() - Method in interface org.flowable.job.api.JobInfo

Returns the message of the exception that occurred, the last time the job was executed.

getExecutionId() - Method in interface org.flowable.job.api.Job

Returns the specific execution on which the job was created.

getId() - Method in interface org.flowable.job.api.JobInfo

Returns the unique identifier for this job.

getJobHandlerConfiguration() - Method in interface org.flowable.job.api.JobInfo

Get the job handler configuration.

getJobHandlerType() - Method in interface org.flowable.job.api.JobInfo

Get the job handler type.

getJobId() - Method in exception org.flowable.job.api.JobNotFoundException

getJobType() - Method in interface org.flowable.job.api.Job

Get the job type for this job.

getLockExpirationTime() - Method in interface org.flowable.job.api.ExternalWorkerJob

getLockOwner() - Method in interface org.flowable.job.api.ExternalWorkerJob

getProcessDefinitionId() - Method in interface org.flowable.job.api.Job

Returns the specific process definition on which the job was created

getProcessInstanceId() - Method in interface org.flowable.job.api.Job

x Returns the id of the process instance which execution created the job.

getRetries() - Method in interface org.flowable.job.api.JobInfo

Returns the number of retries this job has left.

getScopeDefinitionId() - Method in interface org.flowable.job.api.Job

Reference to a scope definition identifier or null if none is set.

getScopeId() - Method in interface org.flowable.job.api.Job

Reference to a scope identifier or null if none is set.

getScopeType() - Method in interface org.flowable.job.api.HistoryJob

Get the scope type.

getScopeType() - Method in interface org.flowable.job.api.Job

Reference to a scope type or null if none is set.

getSubScopeId() - Method in interface org.flowable.job.api.Job

Reference to a sub scope identifier or null if none is set.

getTenantId() - Method in interface org.flowable.job.api.JobInfo

Get the tenant identifier for this job.

getVariables() - Method in interface org.flowable.job.api.AcquiredExternalWorkerJob

H

handlerType(String) - Method in interface org.flowable.job.api.BaseJobQuery

Select jobs which have given job handler type

handlerType(String) - Method in interface org.flowable.job.api.HistoryJobQuery

Select jobs which have given job handler type

handlerType(String) - Method in interface org.flowable.job.api.TimerJobQuery

Select jobs which have given job handler type

handlerTypes(Collection<String>) - Method in interface org.flowable.job.api.BaseJobQuery

Select jobs which have one of the given job handler type

handlerTypes(Collection<String>) - Method in interface org.flowable.job.api.HistoryJobQuery

Select jobs which have given job handler type

HISTORY_JOB_TYPE - Static variable in interface org.flowable.job.api.HistoryJob

HistoryJob - Interface in org.flowable.job.api

Represents one history job

HistoryJobQuery - Interface in org.flowable.job.api

Allows programmatic querying of HistoryJobs.

I

isExclusive() - Method in interface org.flowable.job.api.Job

Is the job exclusive?

J

Job - Interface in org.flowable.job.api

Represents one job (timer, async job, etc.).

JOB_TYPE_EXTERNAL_WORKER - Static variable in interface org.flowable.job.api.Job

JOB_TYPE_MESSAGE - Static variable in interface org.flowable.job.api.Job

JOB_TYPE_TIMER - Static variable in interface org.flowable.job.api.Job

jobId(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs with the given id

jobId(String) - Method in interface org.flowable.job.api.HistoryJobQuery

Only select jobs with the given id

JobInfo - Interface in org.flowable.job.api

Interface for a job that can be directly executed (e.g an async job or a history job).

JobNotFoundException - Exception in org.flowable.job.api

This exception is thrown when you try to execute a job that is not found (may be due to cancelActiviti="true" for instance)..

JobNotFoundException(String) - Constructor for exception org.flowable.job.api.JobNotFoundException

JobQuery - Interface in org.flowable.job.api

Allows programmatic querying of Jobs.

jobTenantId(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs that have the given tenant id.

jobTenantId(String) - Method in interface org.flowable.job.api.HistoryJobQuery

Only select jobs that have the given tenant id.

jobTenantIdLike(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs with a tenant id like the given one.

jobTenantIdLike(String) - Method in interface org.flowable.job.api.HistoryJobQuery

Only select jobs with a tenant id like the given one.

jobWithoutTenantId() - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs that do not have a tenant id.

jobWithoutTenantId() - Method in interface org.flowable.job.api.HistoryJobQuery

Only select jobs that do not have a tenant id.

L

locked() - Method in interface org.flowable.job.api.ExternalWorkerJobQuery

Only return jobs that are locked (i.e.

locked() - Method in interface org.flowable.job.api.HistoryJobQuery

Only return jobs that are locked (i.e.

locked() - Method in interface org.flowable.job.api.JobQuery

Only return jobs that are locked (i.e.

lockOwner(String) - Method in interface org.flowable.job.api.ExternalWorkerJobQuery

Only return jobs with the given lock owner.

lockOwner(String) - Method in interface org.flowable.job.api.HistoryJobQuery

Only return jobs with the given lock owner.

lockOwner(String) - Method in interface org.flowable.job.api.JobQuery

Only return jobs with the given lock owner.

M

MAX_EXCEPTION_MESSAGE_LENGTH - Static variable in interface org.flowable.job.api.Job

MAX_EXCEPTION_MESSAGE_LENGTH - Static variable in interface org.flowable.job.api.JobInfo

messages() - Method in interface org.flowable.job.api.DeadLetterJobQuery

Only select jobs that are messages.

messages() - Method in interface org.flowable.job.api.JobQuery

Only select jobs that are messages.

messages() - Method in interface org.flowable.job.api.SuspendedJobQuery

Only select jobs that are messages.

messages() - Method in interface org.flowable.job.api.TimerJobQuery

Only select jobs that are messages.

N

noRetriesLeft() - Method in interface org.flowable.job.api.SuspendedJobQuery

Only select jobs which have no retries left

O

onlyBpmn() - Method in interface org.flowable.job.api.ExternalWorkerJobAcquireBuilder

Acquire only jobs which are linked to a process instance.

onlyCmmn() - Method in interface org.flowable.job.api.ExternalWorkerJobAcquireBuilder

Acquire only jobs which are linked to a case instance.

orderByExecutionId() - Method in interface org.flowable.job.api.BaseJobQuery

Order by execution id (needs to be followed by Query.asc() or Query.desc()).

orderByJobCreateTime() - Method in interface org.flowable.job.api.BaseJobQuery

Order by create time (needs to be followed by Query.asc() or Query.desc()).

orderByJobDuedate() - Method in interface org.flowable.job.api.BaseJobQuery

Order by duedate (needs to be followed by Query.asc() or Query.desc()).

orderByJobId() - Method in interface org.flowable.job.api.BaseJobQuery

Order by job id (needs to be followed by Query.asc() or Query.desc()).

orderByJobId() - Method in interface org.flowable.job.api.HistoryJobQuery

Order by job id (needs to be followed by Query.asc() or Query.desc()).

orderByJobRetries() - Method in interface org.flowable.job.api.BaseJobQuery

Order by retries (needs to be followed by Query.asc() or Query.desc()).

orderByJobRetries() - Method in interface org.flowable.job.api.HistoryJobQuery

Order by retries (needs to be followed by Query.asc() or Query.desc()).

orderByProcessInstanceId() - Method in interface org.flowable.job.api.BaseJobQuery

Order by process instance id (needs to be followed by Query.asc() or Query.desc()).

orderByTenantId() - Method in interface org.flowable.job.api.BaseJobQuery

Order by tenant id (needs to be followed by Query.asc() or Query.desc()).

orderByTenantId() - Method in interface org.flowable.job.api.HistoryJobQuery

Order by tenant id (needs to be followed by Query.asc() or Query.desc()).

org.flowable.job.api - package org.flowable.job.api

P

planItemInstanceId(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs for the given plan item instance.

processDefinitionId(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs which exist for the given process definition id

processInstanceId(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs which exist for the given process instance.

R

retries(int) - Method in interface org.flowable.job.api.ExternalWorkerJobFailureBuilder

The number of new retries that should be set for the job.

retryTimeout(Duration) - Method in interface org.flowable.job.api.ExternalWorkerJobFailureBuilder

The amount of time to wait before making the job available for a retry.

S

scopeDefinitionId(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select tasks for the given scope definition identifier.

scopeId(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select tasks for the given scope identifier.

scopeType(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select tasks for the given scope type.

scopeType(String) - Method in interface org.flowable.job.api.ExternalWorkerJobAcquireBuilder

Acquire only jobs which are linked to the given scope type.

scopeType(String) - Method in interface org.flowable.job.api.HistoryJobQuery

Only select jobs with the given scope type.

subScopeId(String) - Method in interface org.flowable.job.api.BaseJobQuery

Only select tasks for the given sub scope identifier.

SuspendedJobQuery - Interface in org.flowable.job.api

Allows programmatic querying of Jobs.

T

tenantId(String) - Method in interface org.flowable.job.api.ExternalWorkerJobAcquireBuilder

Acquire only jobs which are within the given tenant.

TimerJobQuery - Interface in org.flowable.job.api

Allows programmatic querying of Jobs.

timers() - Method in interface org.flowable.job.api.DeadLetterJobQuery

Only select jobs that are timers.

timers() - Method in interface org.flowable.job.api.JobQuery

Only select jobs that are timers.

timers() - Method in interface org.flowable.job.api.SuspendedJobQuery

Only select jobs that are timers.

timers() - Method in interface org.flowable.job.api.TimerJobQuery

Only select jobs that are timers.

topic(String, Duration) - Method in interface org.flowable.job.api.ExternalWorkerJobAcquireBuilder

The topic and lock duration for the requested jobs

U

unlocked() - Method in interface org.flowable.job.api.ExternalWorkerJobQuery

Only return jobs that are not locked.

unlocked() - Method in interface org.flowable.job.api.HistoryJobQuery

Only return jobs that are not locked.

unlocked() - Method in interface org.flowable.job.api.JobQuery

Only return jobs that are not locked.

W

withException() - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs that failed due to an exception.

withException() - Method in interface org.flowable.job.api.HistoryJobQuery

Only select jobs that failed due to an exception.

withoutProcessInstanceId() - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs without a process instance id value.

withoutScopeId() - Method in interface org.flowable.job.api.BaseJobQuery

Only select jobs without a scope id value.

withoutScopeType() - Method in interface org.flowable.job.api.BaseJobQuery

Only return jobs that do not have a scope type.

withoutScopeType() - Method in interface org.flowable.job.api.HistoryJobQuery

Only return jobs that do not have a scope type.

withRetriesLeft() - Method in interface org.flowable.job.api.SuspendedJobQuery

Only select jobs which have retries left

A B C D E F G H I J L M N O P R S T U W