com.flowable.dataobject.api.runtime

Interface DataObjectInstanceQuery<T extends DataObjectInstanceQuery<T,U>,U extends DataObjectInstance>

All Superinterfaces:

org.flowable.common.engine.api.query.Query<T,U>

All Known Subinterfaces:

DatabaseSchemaDataObjectInstanceQuery

All Known Implementing Classes:

DatabaseSchemaDataObjectInstanceQueryImpl

public interface DataObjectInstanceQuery<T extends DataObjectInstanceQuery<T,U>,U extends DataObjectInstance>
extends org.flowable.common.engine.api.query.Query<T,U>

The basic data object instance query interface used by DataObjectDataSource which might also be extended with own, type-safe implementations. For a data object instance query, at least the definition id, key or external id must be present in order to map it to the data source for executing the query later on. If the query object is retrieved by DataObjectRuntimeService.createDataObjectInstanceQueryByDefinitionKey(String), the definition key is already be set in the returned query object.

Author:

Micha Kiener

Nested Class Summary

Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query

org.flowable.common.engine.api.query.Query.NullHandlingOnOrder

Method Summary

Modifier and Type	Method and Description
T	definitionExternalId(String externalId)
T	definitionId(String id)
T	definitionKey(String key)
T	fieldValueEquals(String fieldName, Object value) Adds an equals predicate for the specified field name and value provided.
T	fieldValueLike(String fieldName, String value) Adds a like predicate for the specified field name and value provided.
T	id(String id)
T	lookupId(String lookupId)
T	lookupIdLike(String lookupIdLike)
T	tenantId(String tenantId)

Methods inherited from interface org.flowable.common.engine.api.query.Query

asc, count, desc, list, listPage, orderBy, orderBy, singleResult

Method Detail

definitionId

T definitionId(String id)

definitionExternalId

T definitionExternalId(String externalId)

definitionKey

T definitionKey(String key)

id

T id(String id)

lookupId

T lookupId(String lookupId)

lookupIdLike

T lookupIdLike(String lookupIdLike)

tenantId

T tenantId(String tenantId)

fieldValueEquals

T fieldValueEquals(String fieldName,
                   Object value)

Adds an equals predicate for the specified field name and value provided.

Parameters:

fieldName - the name of the field to create a predicate for

value - the value the field needs to be equal to

Returns:

the same query object builder for method chaining

fieldValueLike

T fieldValueLike(String fieldName,
                 String value)

Adds a like predicate for the specified field name and value provided.

Parameters:

fieldName - the name of the field to create a predicate for

value - the value the field needs to be like

Returns:

the same query object builder for method chaining