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

Class SetJobRetriesByProcessAsyncBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.management.SetJobRetriesByProcessAsyncBuilderImpl

All Implemented Interfaces:

SetJobRetriesAsyncBuilder, SetJobRetriesByProcessAsyncBuilder

public class SetJobRetriesByProcessAsyncBuilderImpl
extends Object
implements SetJobRetriesByProcessAsyncBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandExecutor	commandExecutor
protected Date	dueDate
protected HistoricProcessInstanceQuery	historicProcessInstanceQuery
protected boolean	isDueDateSet
protected static CommandLogger	LOG
protected List<String>	processInstanceIds
protected ProcessInstanceQuery	processInstanceQuery
protected Integer	retries

Constructor Summary

Constructors

Constructor	Description
SetJobRetriesByProcessAsyncBuilderImpl(CommandExecutor commandExecutor, int retries)

Method Summary

Modifier and Type	Method	Description
SetJobRetriesByProcessAsyncBuilder	dueDate(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.
SetJobRetriesByProcessAsyncBuilder	historicProcessInstanceQuery(HistoricProcessInstanceQuery query)	Specifies a historic process instance query that identifies runtime process instances with jobs that have to be modified.
SetJobRetriesByProcessAsyncBuilder	processInstanceIds(List<String> processInstanceIds)	Specifies a list of process instance ids.
SetJobRetriesByProcessAsyncBuilder	processInstanceQuery(ProcessInstanceQuery query)	Specifies a process instance query.
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

processInstanceIds

protected List<String> processInstanceIds

processInstanceQuery

protected ProcessInstanceQuery processInstanceQuery

historicProcessInstanceQuery

protected HistoricProcessInstanceQuery historicProcessInstanceQuery

retries

protected Integer retries

dueDate

protected Date dueDate

isDueDateSet

protected boolean isDueDateSet

Constructor Detail

SetJobRetriesByProcessAsyncBuilderImpl

public SetJobRetriesByProcessAsyncBuilderImpl(CommandExecutor commandExecutor,
                                              int retries)

Method Detail

processInstanceIds

public SetJobRetriesByProcessAsyncBuilder processInstanceIds(List<String> processInstanceIds)

Description copied from interface: SetJobRetriesByProcessAsyncBuilder

Specifies a list of process instance ids. All jobs belonging to those process instances will be updated. If this method is called together with more methods referencing jobs, the builder will operate on the jobs referenced by all. If no method referencing jobs is called, a ProcessEngineException is thrown on SetJobRetriesAsyncBuilder.executeAsync().

Specified by:

processInstanceIds in interface SetJobRetriesByProcessAsyncBuilder

Parameters:

processInstanceIds - the list of process instance ids

Returns:

the builder instance

See Also:

ManagementService.setJobRetriesAsync(List, ProcessInstanceQuery, int)

processInstanceQuery

public SetJobRetriesByProcessAsyncBuilder processInstanceQuery(ProcessInstanceQuery query)

Description copied from interface: SetJobRetriesByProcessAsyncBuilder

Specifies a process instance query. All jobs belonging to those process instances will be updated. If this method is called together with more methods referencing jobs, the builder will operate on the jobs referenced by all. If no method referencing jobs is called, a ProcessEngineException is thrown on SetJobRetriesAsyncBuilder.executeAsync().

Specified by:

processInstanceQuery in interface SetJobRetriesByProcessAsyncBuilder

Parameters:

query - the process instance query

Returns:

the builder instance

See Also:

ManagementService.setJobRetriesAsync(List, ProcessInstanceQuery, int)

historicProcessInstanceQuery

public SetJobRetriesByProcessAsyncBuilder historicProcessInstanceQuery(HistoricProcessInstanceQuery query)

Description copied from interface: SetJobRetriesByProcessAsyncBuilder

Specifies a historic process instance query that identifies runtime process instances with jobs that have to be modified. All jobs belonging to those process instances will be updated. If this method is called together with more methods referencing jobs, the builder will operate on the jobs referenced by all. If no method referencing jobs is called, a ProcessEngineException is thrown on SetJobRetriesAsyncBuilder.executeAsync().

Specified by:

historicProcessInstanceQuery in interface SetJobRetriesByProcessAsyncBuilder

Parameters:

query - the historic process instance

Returns:

the builder instance

See Also:

ManagementService.setJobRetriesAsync(List, ProcessInstanceQuery, HistoricProcessInstanceQuery, int)

dueDate

public SetJobRetriesByProcessAsyncBuilder dueDate(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()