Package org.camunda.bpm.engine.management

Interface UpdateJobDefinitionSuspensionStateBuilder

All Known Subinterfaces:

UpdateJobDefinitionSuspensionStateTenantBuilder

All Known Implementing Classes:

UpdateJobDefinitionSuspensionStateBuilderImpl

public interface UpdateJobDefinitionSuspensionStateBuilder

Fluent builder to update the suspension state of job definitions.

Method Summary

Modifier and Type	Method	Description
void	activate()	Activates the provided job definitions.
UpdateJobDefinitionSuspensionStateBuilder	executionDate(Date executionDate)	Specify when the suspension state should be updated.
UpdateJobDefinitionSuspensionStateBuilder	includeJobs(boolean includeJobs)	Specify if the suspension states of the jobs of the provided job definitions should also be updated.
void	suspend()	Suspends the provided job definitions.

Method Detail

includeJobs

UpdateJobDefinitionSuspensionStateBuilder includeJobs(boolean includeJobs)

Specify if the suspension states of the jobs of the provided job definitions should also be updated. Default is false.

Parameters:

includeJobs - if true, all related jobs will be activated / suspended too.

Returns:

the builder

executionDate

UpdateJobDefinitionSuspensionStateBuilder executionDate(Date executionDate)

Specify when the suspension state should be updated. Note that the job executor needs to be active to use this.

Parameters:

executionDate - the date on which the job definition will be activated / suspended. If null, the job definition is activated / suspended immediately.

Returns:

the builder

activate

void activate()

Activates the provided job definitions.

Throws:

AuthorizationException -

if the current user has no Permissions.UPDATE permission on Resources.PROCESS_DEFINITION

If includeJobs(boolean) is set to true and the user have no Permissions.UPDATE_INSTANCE permission on Resources.PROCESS_DEFINITION Permissions.UPDATE permission on any Resources.PROCESS_INSTANCE

suspend

void suspend()

Suspends the provided job definitions. If a job definition is in state suspended, it will be ignored by the job executor.

Throws:

AuthorizationException -

if the current user has no Permissions.UPDATE permission on Resources.PROCESS_DEFINITION

If includeJobs(boolean) is set to true and the user have no Permissions.UPDATE_INSTANCE permission on Resources.PROCESS_DEFINITION Permissions.UPDATE permission on any Resources.PROCESS_INSTANCE