Package org.camunda.bpm.engine.impl

Class QueryOrderingProperty

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    VariableOrderProperty
    public class QueryOrderingProperty
extends Object
implements Serializable

    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 is null. Contains instances of QueryEntityRelationCondition.

    Author:
    Thorben Lindhauer
    See Also:
    Serialized Form

    • Constructor Detail

      • QueryOrderingProperty

        public QueryOrderingProperty()

      • QueryOrderingProperty

        public QueryOrderingProperty​(String relation,
                             QueryProperty queryProperty)

    • Method Detail

      • setQueryProperty

        public void setQueryProperty​(QueryProperty queryProperty)

      • setDirection

        public void setDirection​(Direction direction)

      • getDirection

        public Direction getDirection()

      • hasRelationConditions

        public boolean hasRelationConditions()

      • getRelation

        public String getRelation()

      • setRelation

        public void setRelation​(String relation)

      • 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)

      • getRelationConditionsString

        public String getRelationConditionsString()