com.softwareag.centrasite.appl.framework.persistence.search
Class Order

java.lang.Object
  extended by com.softwareag.centrasite.appl.framework.persistence.search.Order

public final class Order
extends java.lang.Object


Method Summary
static Order asc(java.lang.String propertyName)
          Ascending order on the given property name.
static Order desc(java.lang.String propertyName)
          Descending order on the given property name.
 java.lang.String getOrderQueryString(SearchQuery searchQuery)
          Returns an order query, depending on the Order's property
 Property getProperty()
           
 java.lang.String getPropertyName()
          Returns the Order's property name
 boolean isDescending()
          Returns true if the order is descending , otherwise returns false
 void setProperty(Property property)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getProperty

public Property getProperty()

setProperty

public void setProperty(Property property)

getPropertyName

public java.lang.String getPropertyName()
Returns the Order's property name

Returns:
propertyName

isDescending

public boolean isDescending()
Returns true if the order is descending , otherwise returns false

Returns:
ascending

asc

public static Order asc(java.lang.String propertyName)
Ascending order on the given property name.

Parameters:
propertyName -
Returns:
order instance

desc

public static Order desc(java.lang.String propertyName)
Descending order on the given property name.

Parameters:
propertyName -
Returns:
order instance

getOrderQueryString

public java.lang.String getOrderQueryString(SearchQuery searchQuery)
                                     throws CSAppFrameworkException
Returns an order query, depending on the Order's property

Parameters:
searchQuery -
Returns:
String
Throws:
CSAppFrameworkException