org.camunda.bpm.engine.impl

Class EventSubscriptionQueryImpl

java.lang.Object

org.camunda.bpm.engine.impl.db.ListQueryParameterObject

org.camunda.bpm.engine.impl.AbstractQuery<EventSubscriptionQuery,EventSubscription>

org.camunda.bpm.engine.impl.EventSubscriptionQueryImpl

All Implemented Interfaces:

Serializable, Command<Object>, Query<EventSubscriptionQuery,EventSubscription>, EventSubscriptionQuery

public class EventSubscriptionQueryImpl
extends AbstractQuery<EventSubscriptionQuery,EventSubscription>
implements Serializable, EventSubscriptionQuery

Author:

Daniel Meyer

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery

AbstractQuery.ResultType

Field Summary

Fields

Modifier and Type	Field and Description
protected String	activityId
protected String	eventName
protected String	eventSubscriptionId
protected String	eventType
protected String	executionId
protected boolean	includeEventSubscriptionsWithoutTenantId
protected boolean	isTenantIdSet
protected String	processInstanceId
protected String[]	tenantIds

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery

commandExecutor, expressions, maxResultsLimitEnabled, resultType, SORTORDER_ASC, SORTORDER_DESC, validators

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck

Constructor Summary

Constructors

Constructor and Description
EventSubscriptionQueryImpl()
EventSubscriptionQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method and Description
EventSubscriptionQueryImpl	activityId(String activityId) Only select subscriptions that belong to an activity with the given id.
EventSubscriptionQuery	eventName(String eventName) Only select subscriptions for events with the given name.
EventSubscriptionQuery	eventSubscriptionId(String id) Only select subscriptions with the given id.
EventSubscriptionQueryImpl	eventType(String eventType) Only select subscriptions for events with the given type.
long	executeCount(CommandContext commandContext)
List<EventSubscription>	executeList(CommandContext commandContext, Page page) Executes the actual query to retrieve the list of results.
EventSubscriptionQueryImpl	executionId(String executionId) Only select subscriptions that belong to an execution with the given id.
String	getActivityId()
String	getEventName()
String	getEventSubscriptionId()
String	getEventType()
String	getExecutionId()
String	getProcessInstanceId()
EventSubscriptionQuery	includeEventSubscriptionsWithoutTenantId() Select subscriptions which have no tenant id.
EventSubscriptionQuery	orderByCreated() Order by event subscription creation date (needs to be followed by Query.asc() or Query.desc()).
EventSubscriptionQuery	orderByTenantId() Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
EventSubscriptionQuery	processInstanceId(String processInstanceId) Only select subscriptions that belong to a process instance with the given id.
EventSubscriptionQuery	tenantIdIn(String... tenantIds) Only select subscriptions that belong to one of the given tenant ids.
EventSubscriptionQuery	withoutTenantId() Only select subscriptions which have no tenant id.

Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery

addExpression, addValidator, asc, checkMaxResultsLimit, checkQueryOk, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeIdsList, executeResult, executeSingleResult, extend, getExpressions, getMethod, hasExcludingConditions, list, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, unlimitedList, validate, validate

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderingProperties, setParameter, setTenantCheck

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.camunda.bpm.engine.query.Query

asc, count, desc, list, listPage, singleResult, unlimitedList

Field Detail

eventSubscriptionId

protected String eventSubscriptionId

eventName

protected String eventName

eventType

protected String eventType

executionId

protected String executionId

processInstanceId

protected String processInstanceId

activityId

protected String activityId

isTenantIdSet

protected boolean isTenantIdSet

tenantIds

protected String[] tenantIds

includeEventSubscriptionsWithoutTenantId

protected boolean includeEventSubscriptionsWithoutTenantId

Constructor Detail

EventSubscriptionQueryImpl

public EventSubscriptionQueryImpl()

EventSubscriptionQueryImpl

public EventSubscriptionQueryImpl(CommandExecutor commandExecutor)

Method Detail

eventSubscriptionId

public EventSubscriptionQuery eventSubscriptionId(String id)

Description copied from interface: EventSubscriptionQuery

Only select subscriptions with the given id.

Specified by:

eventSubscriptionId in interface EventSubscriptionQuery

eventName

public EventSubscriptionQuery eventName(String eventName)

Description copied from interface: EventSubscriptionQuery

Only select subscriptions for events with the given name.

Specified by:

eventName in interface EventSubscriptionQuery

executionId

public EventSubscriptionQueryImpl executionId(String executionId)

Description copied from interface: EventSubscriptionQuery

Only select subscriptions that belong to an execution with the given id.

Specified by:

executionId in interface EventSubscriptionQuery

processInstanceId

public EventSubscriptionQuery processInstanceId(String processInstanceId)

Description copied from interface: EventSubscriptionQuery

Only select subscriptions that belong to a process instance with the given id.

Specified by:

processInstanceId in interface EventSubscriptionQuery

activityId

public EventSubscriptionQueryImpl activityId(String activityId)

Description copied from interface: EventSubscriptionQuery

Only select subscriptions that belong to an activity with the given id.

Specified by:

activityId in interface EventSubscriptionQuery

tenantIdIn

public EventSubscriptionQuery tenantIdIn(String... tenantIds)

Description copied from interface: EventSubscriptionQuery

Only select subscriptions that belong to one of the given tenant ids.

Specified by:

tenantIdIn in interface EventSubscriptionQuery

withoutTenantId

public EventSubscriptionQuery withoutTenantId()

Description copied from interface: EventSubscriptionQuery

Only select subscriptions which have no tenant id.

Specified by:

withoutTenantId in interface EventSubscriptionQuery

includeEventSubscriptionsWithoutTenantId

public EventSubscriptionQuery includeEventSubscriptionsWithoutTenantId()

Description copied from interface: EventSubscriptionQuery

Select subscriptions which have no tenant id. Can be used in combination with EventSubscriptionQuery.tenantIdIn(String...).

Specified by:

includeEventSubscriptionsWithoutTenantId in interface EventSubscriptionQuery

eventType

public EventSubscriptionQueryImpl eventType(String eventType)

Description copied from interface: EventSubscriptionQuery

Only select subscriptions for events with the given type. "message" selects message event subscriptions, "signal" selects signal event subscriptions, "compensation" selects compensation event subscriptions, "conditional" selects conditional event subscriptions.

Specified by:

eventType in interface EventSubscriptionQuery

orderByCreated

public EventSubscriptionQuery orderByCreated()

Description copied from interface: EventSubscriptionQuery

Order by event subscription creation date (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByCreated in interface EventSubscriptionQuery

orderByTenantId

public EventSubscriptionQuery orderByTenantId()

Description copied from interface: EventSubscriptionQuery

Order by tenant id (needs to be followed by Query.asc() or Query.desc()). Note that the ordering of subscriptions without tenant id is database-specific.

Specified by:

orderByTenantId in interface EventSubscriptionQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<EventSubscriptionQuery,EventSubscription>

executeList

public List<EventSubscription> executeList(CommandContext commandContext,
                                           Page page)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<EventSubscriptionQuery,EventSubscription>

page - used if the results must be paged. If null, no paging will be applied.

getEventSubscriptionId

public String getEventSubscriptionId()

getEventName

public String getEventName()

getEventType

public String getEventType()

getExecutionId

public String getExecutionId()

getProcessInstanceId

public String getProcessInstanceId()

getActivityId

public String getActivityId()