org.camunda.bpm.engine.batch
Interface BatchQuery

All Superinterfaces:
Query<BatchQuery,Batch>
All Known Implementing Classes:
BatchQueryImpl

public interface BatchQuery
extends Query<BatchQuery,Batch>

Query for Batch instances.


Method Summary
 BatchQuery active()
          Only selects batches which are active
 BatchQuery batchId(String batchId)
          Only select batch instances for the given batch id.
 BatchQuery orderById()
          Returns batches sorted by id; must be followed by an invocation of Query.asc() or Query.desc().
 BatchQuery orderByTenantId()
          Returns batches sorted by tenant id; must be followed by an invocation of Query.asc() or Query.desc().
 BatchQuery suspended()
          Only selects batches which are suspended
 BatchQuery tenantIdIn(String... tenantIds)
          Only selects batches with one of the given tenant ids.
 BatchQuery type(String type)
          Only select batches of the given type.
 BatchQuery withoutTenantId()
          Only selects batches which have no tenant id.
 
Methods inherited from interface org.camunda.bpm.engine.query.Query
asc, count, desc, list, listPage, singleResult
 

Method Detail

batchId

BatchQuery batchId(String batchId)
Only select batch instances for the given batch id.


type

BatchQuery type(String type)
Only select batches of the given type.


tenantIdIn

BatchQuery tenantIdIn(String... tenantIds)
Only selects batches with one of the given tenant ids.


withoutTenantId

BatchQuery withoutTenantId()
Only selects batches which have no tenant id.


active

BatchQuery active()
Only selects batches which are active


suspended

BatchQuery suspended()
Only selects batches which are suspended


orderById

BatchQuery orderById()
Returns batches sorted by id; must be followed by an invocation of Query.asc() or Query.desc().


orderByTenantId

BatchQuery orderByTenantId()
Returns batches sorted by tenant id; must be followed by an invocation of Query.asc() or Query.desc().



Copyright © 2017 camunda services GmbH. All rights reserved.