com.softwareag.centrasite.api.csom.search
Interface CSOSortSpecifier


public interface CSOSortSpecifier

The order of a search result is defined by a list of CSSortSpecifier. A CSOSortSpecifier consists of a CSOAttribute and a direction indicator (Direction.ascending, Direction.descending).


Nested Class Summary
static class CSOSortSpecifier.Direction
           
 
Method Summary
 CentraSiteObjectAttribute getSortAttribute()
          Returns the sort attribute.
 CSOSortSpecifier.Direction getSortDirection()
          Gets the direction of the sort specifier
 void setSortAttribute(CentraSiteObjectAttribute centraSiteObjectAttribute)
          Add an attribute for further filtering of the sort specifier.
 void setSortDirection(CSOSortSpecifier.Direction sortDirection)
          Sets the direction of the sort specifier
 

Method Detail

getSortAttribute

CentraSiteObjectAttribute getSortAttribute()
Returns the sort attribute.

Returns:
CSOAttribute on which CSOSortSpecifier needs to be built

setSortAttribute

void setSortAttribute(CentraSiteObjectAttribute centraSiteObjectAttribute)
Add an attribute for further filtering of the sort specifier.

Parameters:
centraSiteObjectAttribute - on which CSOSortSpecifier needs to be built

getSortDirection

CSOSortSpecifier.Direction getSortDirection()
Gets the direction of the sort specifier

Returns:
enum which specifies the direction of sort order

setSortDirection

void setSortDirection(CSOSortSpecifier.Direction sortDirection)
Sets the direction of the sort specifier

Parameters:
sortDirection - sets the direction of sort