Package org.camunda.bpm.engine.impl
Class QueryOrderingProperty
java.lang.Object
org.camunda.bpm.engine.impl.QueryOrderingProperty
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
VariableOrderProperty
A QueryOrderingProperty specifies a condition by which the results of a query should be
sorted. It can either specify a sorting by a property of the entities to be selected or
a sorting by a property of a related entity. For example in a TaskQuery
,
the entity to be selected is Task
while a related entity could be a
VariableInstance
.
It is made up of the following:
- relation
- A symbolic name that identifies a related entity.
null
if an ordering over a property of the entity to be selected is expressed. - queryProperty
- The property to be sorted on. An instance of
QueryProperty
. - direction
- The ordering direction, refer to
Direction
- relationConditions
- A list of constraints that describe the nature of the relation to another entity
(or in SQL terms, the joining conditions). Is
null
if relation isnull
. Contains instances ofQueryEntityRelationCondition
.
- Author:
- Thorben Lindhauer
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected Direction
protected QueryProperty
protected String
static final String
static final String
static final String
static final String
protected List<QueryEntityRelationCondition>
protected static final long
-
Constructor Summary
ConstructorDescriptionQueryOrderingProperty
(String relation, QueryProperty queryProperty) QueryOrderingProperty
(QueryProperty queryProperty, Direction direction) -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
void
setDirection
(Direction direction) void
setQueryProperty
(QueryProperty queryProperty) void
setRelation
(String relation) void
setRelationConditions
(List<QueryEntityRelationCondition> relationConditions) toString()
-
Field Details
-
RELATION_VARIABLE
- See Also:
-
RELATION_PROCESS_DEFINITION
- See Also:
-
RELATION_CASE_DEFINITION
- See Also:
-
RELATION_DEPLOYMENT
- See Also:
-
serialVersionUID
protected static final long serialVersionUID- See Also:
-
relation
-
queryProperty
-
direction
-
relationConditions
-
-
Constructor Details
-
QueryOrderingProperty
public QueryOrderingProperty() -
QueryOrderingProperty
-
QueryOrderingProperty
-
-
Method Details
-
getQueryProperty
-
setQueryProperty
-
setDirection
-
getDirection
-
getRelationConditions
-
setRelationConditions
-
hasRelationConditions
public boolean hasRelationConditions() -
getRelation
-
setRelation
-
isContainedProperty
public boolean isContainedProperty()- Returns:
- whether this ordering property is contained in the default fields of the base entity (e.g. task.NAME_ is a contained property; LOWER(task.NAME_) or variable.TEXT_ (given a task query) is not contained)
-
toString
-
getRelationConditionsString
-