de.espirit.or.query

Class Order

java.lang.Object

de.espirit.or.query.Order

All Implemented Interfaces:

Serializable, Cloneable

public class Order
extends Object
implements Cloneable, Serializable

Parameter class for order criteria used for or selects

Since:

4.0.17

See Also:

Select.add(Order), Select.isOrdered(String), Serialized Form

Constructor Summary

Constructors

Constructor and Description
Order(String attribute) Creates an order criteria based on the attribute specified by the given attribute name and with ascending ordering.
Order(String attribute, boolean ascending) Creates an order criteria based on the attribute specified by the given attribute name and with ordering specified by the given ascending parameter.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttribute() Returns the name of the attribute this order criteria is related to.
boolean	isAscending() Indicates whether the ordering of this order criteria is ascending or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Order

public Order(@NotNull
     String attribute)

Creates an order criteria based on the attribute specified by the given attribute name and with ascending ordering.

Parameters:

attribute - the name of the attribute the created order criteria should be related to

Since:

4.0.17

Order

public Order(@NotNull
     String attribute,
     boolean ascending)

Creates an order criteria based on the attribute specified by the given attribute name and with ordering specified by the given ascending parameter.

Parameters:

attribute - the name of the attribute the created order criteria should be related to

ascending - specifies the ordering of the created order criteria, use true for ascending ordering, false for descending

Since:

4.0.17

Method Detail

getAttribute

public String getAttribute()

Returns the name of the attribute this order criteria is related to.

Returns:

the name of the attribute this order criteria is based on.

Since:

4.0.17

isAscending

public boolean isAscending()

Indicates whether the ordering of this order criteria is ascending or not.

Returns:

true if the ordering of this order criteria is ascending, false for descending ordering

Since:

4.0.17