org.kuali.rice.core.api.criteria
Class OrderByField

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.core.api.criteria.OrderByField

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete

public final class OrderByField
extends AbstractDataTransferObject

Defines a criteria-based query. Consists of a Predicate definition as well as a set of additional properties which control paging and other aspects of the results which should be returned from the query.

In order to construct a new OrderByField, the OrderByField.Builder should be used. Use the PredicateFactory to construct the predicate for use by the query.

This class specifies nothing regarding how the query will be executed. It is expected that an instance will be constructed and then passed to code which understands how to execute the desired query.

This class is mapped for use by JAXB and can therefore be used by clients as part of remotable service definitions.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Predicate, PredicateFactory, Serialized Form

Nested Class Summary

static class

OrderByField.Builder

Method Summary

String	getFieldName() Returns the a name of the field to order results on
OrderDirection	getOrderDirection() Indicates what direction row ordering is used (ascending or descending)

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getFieldName

public String getFieldName()

Returns the a name of the field to order results on

Returns:

field names that will affect the order of the returned rows

getOrderDirection

public OrderDirection getOrderDirection()

Indicates what direction row ordering is used (ascending or descending)

Returns:

the flag specifying whether or not ascending or descending order is used