public final class Order
extends java.lang.Object
Search
results. The order Class holds
information about the Order:
Property
instance, created after the order is added to a search objectModifier and Type | Method and Description |
---|---|
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()
Gets the Property instance.
|
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)
Sets the property instance.
|
public void setProperty(Property property)
property
- The Property
instance to setpublic java.lang.String getPropertyName()
public boolean isDescending()
true
if the order is descending and false
otherwisepublic static Order asc(java.lang.String propertyName)
propertyName
- The property nameOrder
instancepublic static Order desc(java.lang.String propertyName)
propertyName
- The property nameOrder
instancepublic java.lang.String getOrderQueryString(SearchQuery searchQuery) throws CSAppFrameworkException
searchQuery
- The SearchQuery
objectCSAppFrameworkException
- If an error occurs while trying to get the query string