Package org.camunda.bpm.engine.impl.externaltask

Class FetchAndLockBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.externaltask.FetchAndLockBuilderImpl

All Implemented Interfaces:

FetchAndLockBuilder

public class FetchAndLockBuilderImpl
extends Object
implements FetchAndLockBuilder

Implementation of FetchAndLockBuilder.

Field Summary

Fields

Modifier and Type	Field	Description
protected final CommandExecutor	commandExecutor
protected int	maxTasks
protected List<QueryOrderingProperty>	orderingProperties
protected boolean	usePriority
protected String	workerId

Constructor Summary

Constructors

Constructor	Description
FetchAndLockBuilderImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
FetchAndLockBuilderImpl	asc()	Configures the order to be ascending.
protected void	checkQueryOk()
protected void	configureLastOrderingPropertyDirection(Direction direction)
FetchAndLockBuilderImpl	desc()	Configures the order to be descending.
FetchAndLockBuilderImpl	maxTasks(int maxTasks)	Configures the max tasks fetching that will be used during the Fetch and Lock operation.
FetchAndLockBuilderImpl	orderByCreateTime()	Configures the fetching during the Fetch and Lock Operation to include ordering by create time of the external tasks.
ExternalTaskQueryTopicBuilder	subscribe()	Returns the ExternalTaskQueryTopicBuilder to handle all the configuration that applies per topic.
FetchAndLockBuilderImpl	usePriority(boolean usePriority)	Configures fetching to consider (or not) priority during the Fetch and Lock operation.
FetchAndLockBuilderImpl	workerId(String workerId)	Configures the workerId that will be used during the Fetch and Lock operation.

Methods inherited from class java.lang.Object

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

Field Details

commandExecutor

protected final CommandExecutor commandExecutor

workerId

protected String workerId

maxTasks

protected int maxTasks

usePriority

protected boolean usePriority

orderingProperties

protected List<QueryOrderingProperty> orderingProperties

Constructor Details

FetchAndLockBuilderImpl

public FetchAndLockBuilderImpl(CommandExecutor commandExecutor)

Method Details

workerId

public FetchAndLockBuilderImpl workerId(String workerId)

Description copied from interface: FetchAndLockBuilder

Configures the workerId that will be used during the Fetch and Lock operation.

Specified by:

workerId in interface FetchAndLockBuilder

Parameters:

workerId - the given workerId

Returns:

the builder

maxTasks

public FetchAndLockBuilderImpl maxTasks(int maxTasks)

Description copied from interface: FetchAndLockBuilder

Configures the max tasks fetching that will be used during the Fetch and Lock operation.

Specified by:

maxTasks in interface FetchAndLockBuilder

Parameters:

maxTasks - the given number of max tasks

Returns:

the builder

usePriority

public FetchAndLockBuilderImpl usePriority(boolean usePriority)

Description copied from interface: FetchAndLockBuilder

Configures fetching to consider (or not) priority during the Fetch and Lock operation.

Specified by:

usePriority in interface FetchAndLockBuilder

Parameters:

usePriority - the given usePriority flag. If true, tasks will be fetched in descending order.

Returns:

the builder

orderByCreateTime

public FetchAndLockBuilderImpl orderByCreateTime()

Description copied from interface: FetchAndLockBuilder

Configures the fetching during the Fetch and Lock Operation to include ordering by create time of the external tasks. This method can be combined by calling asc() or desc() afterwards to define an ascending or descending order respectively.

Specified by:

orderByCreateTime in interface FetchAndLockBuilder

Returns:

the builder

asc

public FetchAndLockBuilderImpl asc()
                            throws NotValidException

Description copied from interface: FetchAndLockBuilder

Configures the order to be ascending.

Specified by:

asc in interface FetchAndLockBuilder

Returns:

the builder

Throws:

NotValidException

desc

public FetchAndLockBuilderImpl desc()
                             throws NotValidException

Description copied from interface: FetchAndLockBuilder

Configures the order to be descending.

Specified by:

desc in interface FetchAndLockBuilder

Returns:

the builder

Throws:

NotValidException

subscribe

public ExternalTaskQueryTopicBuilder subscribe()

Description copied from interface: FetchAndLockBuilder

Returns the ExternalTaskQueryTopicBuilder to handle all the configuration that applies per topic.

Specified by:

subscribe in interface FetchAndLockBuilder

Returns:

the builder

configureLastOrderingPropertyDirection

protected void configureLastOrderingPropertyDirection(Direction direction)

checkQueryOk

protected void checkQueryOk()