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

Class SetJobRetriesBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.management.SetJobRetriesBuilderImpl

All Implemented Interfaces:

SetJobRetriesBuilder

public class SetJobRetriesBuilderImpl
extends Object
implements SetJobRetriesBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandExecutor	commandExecutor
protected Date	dueDate
protected boolean	isDueDateSet
protected String	jobDefinitionId
protected String	jobId
protected List<String>	jobIds
protected static CommandLogger	LOG
protected Integer	retries

Constructor Summary

Constructors

Constructor	Description
SetJobRetriesBuilderImpl(CommandExecutor commandExecutor, int retries)

Method Summary

Modifier and Type	Method	Description
SetJobRetriesBuilder	dueDate(Date dueDate)	Specifies a due date to be set on the referenced jobs.
void	execute()	Closes the fluent builder and executes the instructions.
SetJobRetriesBuilder	jobDefinitionId(String jobDefinitionId)	Specifies a Job definition id for the set retries action.
SetJobRetriesBuilder	jobId(String jobId)	Specifies a single Job by it's ID for the set retries action.
SetJobRetriesBuilder	jobIds(List<String> jobIds)	Specifies a list of jobs by their IDs for the set retries action.
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

jobId

protected String jobId

jobIds

protected List<String> jobIds

jobDefinitionId

protected String jobDefinitionId

retries

protected Integer retries

dueDate

protected Date dueDate

isDueDateSet

protected boolean isDueDateSet

Constructor Detail

SetJobRetriesBuilderImpl

public SetJobRetriesBuilderImpl(CommandExecutor commandExecutor,
                                int retries)

Method Detail

jobId

public SetJobRetriesBuilder jobId(String jobId)

Description copied from interface: SetJobRetriesBuilder

Specifies a single Job by it's ID for the set retries action. Note: Only one method of referencing jobs is allowed. If you use jobId, you can not use jobIds or jobDefinitionId.

Specified by:

jobId in interface SetJobRetriesBuilder

Parameters:

jobId - the Id of the job. Must not be null or empty ("").

Returns:

the builder instance

See Also:

ManagementService.setJobRetries(String, int)

jobIds

public SetJobRetriesBuilder jobIds(List<String> jobIds)

Description copied from interface: SetJobRetriesBuilder

Specifies a list of jobs by their IDs for the set retries action. Note: Only one method of referencing jobs is allowed. If you use jobIds, you can not use jobId or jobDefinitionId.

Specified by:

jobIds in interface SetJobRetriesBuilder

Parameters:

jobIds - the list of job ids. Must not be null or empty and only contain valid job ids.

Returns:

the builder instance

See Also:

ManagementService.setJobRetries(List, int)

jobDefinitionId

public SetJobRetriesBuilder jobDefinitionId(String jobDefinitionId)

Description copied from interface: SetJobRetriesBuilder

Specifies a Job definition id for the set retries action. All failed jobs with that definition id will be updated. Note: Only one method of referencing jobs is allowed. If you use jobDefinitionId, you can not use jobId or jobId.

Specified by:

jobDefinitionId in interface SetJobRetriesBuilder

Parameters:

jobDefinitionId - the job definition id. Must not be null or empty ("").

Returns:

the builder instance

See Also:

ManagementService.setJobRetriesByJobDefinitionId(String, int)

dueDate

public SetJobRetriesBuilder dueDate(Date dueDate)

Description copied from interface: SetJobRetriesBuilder

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 SetJobRetriesBuilder

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

execute

public void execute()

Description copied from interface: SetJobRetriesBuilder

Closes the fluent builder and executes the instructions.

Specified by:

execute in interface SetJobRetriesBuilder

validateParameters

protected void validateParameters()