org.camunda.bpm.engine.impl.externaltask

Class ExternalTaskQueryTopicBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.externaltask.ExternalTaskQueryTopicBuilderImpl

All Implemented Interfaces:

ExternalTaskQueryBuilder, ExternalTaskQueryTopicBuilder

public class ExternalTaskQueryTopicBuilderImpl
extends Object
implements ExternalTaskQueryTopicBuilder

Author:

Thorben Lindhauer

Field Summary

Fields

Modifier and Type	Field and Description
protected TopicFetchInstruction	instruction
protected ExternalTaskQueryBuilderImpl	queryBuilder

Constructor Summary

Constructors

Constructor and Description
ExternalTaskQueryTopicBuilderImpl(ExternalTaskQueryBuilderImpl queryBuilder, String topicName, long lockDuration)

Method Summary

Methods

Modifier and Type	Method and Description
List<LockedExternalTask>	execute() Performs the fetching.
protected void	submitInstruction()
ExternalTaskQueryTopicBuilder	topic(String topicName, long lockDuration) Specifies that tasks of a topic should be fetched and locked for a certain amount of time
ExternalTaskQueryTopicBuilder	variables(List<String> variables) Define variables to fetch with all tasks for the current topic.
ExternalTaskQueryTopicBuilder	variables(String... variables) Define variables to fetch with all tasks for the current topic.

Methods inherited from class java.lang.Object

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

Field Detail

instruction

protected TopicFetchInstruction instruction

queryBuilder

protected ExternalTaskQueryBuilderImpl queryBuilder

Constructor Detail

ExternalTaskQueryTopicBuilderImpl

public ExternalTaskQueryTopicBuilderImpl(ExternalTaskQueryBuilderImpl queryBuilder,
                                 String topicName,
                                 long lockDuration)

Method Detail

topic

public ExternalTaskQueryTopicBuilder topic(String topicName,
                                  long lockDuration)

Description copied from interface: ExternalTaskQueryBuilder

Specifies that tasks of a topic should be fetched and locked for a certain amount of time

Specified by:

topic in interface ExternalTaskQueryBuilder

Parameters:

topicName - the name of the topic

lockDuration - the duration in milliseconds for which tasks should be locked; begins at the time of fetching

Returns:

execute

public List<LockedExternalTask> execute()

Description copied from interface: ExternalTaskQueryBuilder

Performs the fetching. Locks candidate tasks of the given topics for the specified duration.

Specified by:

execute in interface ExternalTaskQueryBuilder

Returns:

fetched external tasks that match the topic and that can be successfully locked

variables

public ExternalTaskQueryTopicBuilder variables(String... variables)

Description copied from interface: ExternalTaskQueryTopicBuilder

Define variables to fetch with all tasks for the current topic. Calling this method multiple times overrides the previously specified variables.

Specified by:

variables in interface ExternalTaskQueryTopicBuilder

Parameters:

variables - the variable names to fetch

Returns:

this builder

variables

public ExternalTaskQueryTopicBuilder variables(List<String> variables)

Description copied from interface: ExternalTaskQueryTopicBuilder

Define variables to fetch with all tasks for the current topic. Calling this method multiple times overrides the previously specified variables.

Specified by:

variables in interface ExternalTaskQueryTopicBuilder

Parameters:

variables - the variable names to fetch

Returns:

this builder

submitInstruction

protected void submitInstruction()