Package org.camunda.bpm.engine.impl.management

Class SetJobRetriesByJobsAsyncBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.management.SetJobRetriesByJobsAsyncBuilderImpl

All Implemented Interfaces:

SetJobRetriesAsyncBuilder, SetJobRetriesByJobsAsyncBuilder

public class SetJobRetriesByJobsAsyncBuilderImpl
extends java.lang.Object
implements SetJobRetriesByJobsAsyncBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandExecutor	commandExecutor
protected java.util.Date	dueDate
protected boolean	isDueDateSet
protected java.util.List<java.lang.String>	jobIds
protected JobQuery	jobQuery
protected static CommandLogger	LOG
protected java.lang.Integer	retries

Constructor Summary

Constructors

Constructor	Description
SetJobRetriesByJobsAsyncBuilderImpl(CommandExecutor commandExecutor, int retries)

Method Summary

Modifier and Type	Method	Description
SetJobRetriesAsyncBuilder	dueDate(java.util.Date dueDate)	Specifies a due date to be set on the referenced jobs.
Batch	executeAsync()	Closes the fluent builder and creates a Batch that sets the job retries and executes any additional instructions.
SetJobRetriesByJobsAsyncBuilder	jobIds(java.util.List<java.lang.String> jobIds)	Specifies a list of job ids that will be updated.
SetJobRetriesByJobsAsyncBuilder	jobQuery(JobQuery query)	Specifies a JobQuery to reference jobs that will be updated.
protected void	validateParameters()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final CommandLogger LOG

commandExecutor

protected final CommandExecutor commandExecutor

jobIds

protected java.util.List<java.lang.String> jobIds

jobQuery

protected JobQuery jobQuery

retries

protected java.lang.Integer retries

dueDate

protected java.util.Date dueDate

isDueDateSet

protected boolean isDueDateSet

Constructor Detail

SetJobRetriesByJobsAsyncBuilderImpl

public SetJobRetriesByJobsAsyncBuilderImpl(CommandExecutor commandExecutor,
                                           int retries)

Method Detail

jobQuery

public SetJobRetriesByJobsAsyncBuilder jobQuery(JobQuery query)

Description copied from interface: SetJobRetriesByJobsAsyncBuilder

Specifies a JobQuery to reference jobs that will be updated. If this method and SetJobRetriesByJobsAsyncBuilder.jobIds(List) is called together, the builder will operate on the jobs referenced by job query and job ids. If neither method is called, a ProcessEngineException is thrown on SetJobRetriesAsyncBuilder.executeAsync().

Specified by:

jobQuery in interface SetJobRetriesByJobsAsyncBuilder

Parameters:

query - the query to reference jobs that will be updated.

Returns:

the builder instance

See Also:

ManagementService.setJobRetriesAsync(JobQuery, int)

jobIds

public SetJobRetriesByJobsAsyncBuilder jobIds(java.util.List<java.lang.String> jobIds)

Description copied from interface: SetJobRetriesByJobsAsyncBuilder

Specifies a list of job ids that will be updated. If this method and SetJobRetriesByJobsAsyncBuilder.jobQuery(JobQuery) is called together, the builder will operate on the jobs referenced by job query and job ids. If neither method is called, a ProcessEngineException is thrown on SetJobRetriesAsyncBuilder.executeAsync().

Specified by:

jobIds in interface SetJobRetriesByJobsAsyncBuilder

Parameters:

jobIds - The list of job ids that will be updated.

Returns:

the builder instance

See Also:

ManagementService.setJobRetriesAsync(JobQuery, int)

dueDate

public SetJobRetriesAsyncBuilder dueDate(java.util.Date dueDate)

Description copied from interface: SetJobRetriesAsyncBuilder

Specifies a due date to be set on the referenced jobs. When the number of retries of a job are incremented it is not automatically scheduled for immediate execution. When a Job is executed is determined by the due date. By setting the due date together with the job retries, the scheduled execution date of the job can be adjusted.

Specified by:

dueDate in interface SetJobRetriesAsyncBuilder

Parameters:

dueDate - The new due date for the updated jobs. If it is null, the due date will be set to null. If ensureJobDueDateNotNull is true, the due date will be set to the current date instead of null.

Returns:

the builder instance

executeAsync

public Batch executeAsync()

Description copied from interface: SetJobRetriesAsyncBuilder

Closes the fluent builder and creates a Batch that sets the job retries and executes any additional instructions.

Specified by:

executeAsync in interface SetJobRetriesAsyncBuilder

validateParameters

protected void validateParameters()