org.camunda.bpm.engine.runtime

Interface EventSubscriptionQuery

All Superinterfaces:

Query<EventSubscriptionQuery,EventSubscription>

All Known Implementing Classes:

EventSubscriptionQueryImpl

public interface EventSubscriptionQuery
extends Query<EventSubscriptionQuery,EventSubscription>

Allows querying of event subscriptions.

Author:

Thorben Lindhauer

Method Summary

Methods

Modifier and Type	Method and Description
EventSubscriptionQuery	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.
EventSubscriptionQuery	eventType(String eventType) Only select subscriptions for events with the given type.
EventSubscriptionQuery	executionId(String executionId) Only select subscriptions that belong to an execution with the given id.
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 interface org.camunda.bpm.engine.query.Query

asc, count, desc, list, listPage, singleResult

Method Detail

eventSubscriptionId

EventSubscriptionQuery eventSubscriptionId(String id)

Only select subscriptions with the given id.

eventName

EventSubscriptionQuery eventName(String eventName)

Only select subscriptions for events with the given name.

eventType

EventSubscriptionQuery eventType(String eventType)

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.

executionId

EventSubscriptionQuery executionId(String executionId)

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

processInstanceId

EventSubscriptionQuery processInstanceId(String processInstanceId)

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

activityId

EventSubscriptionQuery activityId(String activityId)

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

tenantIdIn

EventSubscriptionQuery tenantIdIn(String... tenantIds)

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

withoutTenantId

EventSubscriptionQuery withoutTenantId()

Only select subscriptions which have no tenant id.

includeEventSubscriptionsWithoutTenantId

EventSubscriptionQuery includeEventSubscriptionsWithoutTenantId()

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

orderByCreated

EventSubscriptionQuery orderByCreated()

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

orderByTenantId

EventSubscriptionQuery orderByTenantId()

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.