com.endeca.infront.cartridge.model
Class Sort

java.lang.Object
  com.endeca.infront.cartridge.model.Sort

public class Sort
extends Object

Represents a group of actions (both ascending and descending) to sort by a single field

Constructor Summary

Sort()

Method Summary

SortOptionLabel	getAscendingAction() This label's action when the sort is "ascending"
SortOptionLabel	getDescendingAction() This label's action when the sort is "descending"
String	getFieldName() name of the field that will be sorted
void	setAscendingAction(SortOptionLabel ascendingAction)
void	setDescendingAction(SortOptionLabel descendingAction)
void	setFieldName(String fieldName)

Methods inherited from class java.lang.Object

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

Constructor Detail

Sort

public Sort()

Method Detail

getFieldName

public String getFieldName()

name of the field that will be sorted

setFieldName

public void setFieldName(String fieldName)

See Also:

getFieldName()

getAscendingAction

public SortOptionLabel getAscendingAction()

This label's action when the sort is "ascending"

By default this action's label will be the same as the fieldName of this object. It's Navigation State will set the sort parameter (usually Ns) to be equal to [fieldName]|0 (except in the case of the defaultSort which is the equivalent to completely removing the sort parameter). In addition if current Navigation State is the same as the state represented by this action, this action will be selected.

setAscendingAction

public void setAscendingAction(SortOptionLabel ascendingAction)

See Also:

getAscendingAction()

getDescendingAction

public SortOptionLabel getDescendingAction()

This label's action when the sort is "descending"

By default this action's label will be the same as the fieldName of this object. It's Navigation State will set the sort parameter (usually Ns) to be equal to [fieldName]|1 (except in the case of the defaultSort which is the equivalent to completely removing the sort parameter). In addition if current Navigation State is the same as the state represented by this action, this action will be selected.

setDescendingAction

public void setDescendingAction(SortOptionLabel descendingAction)

See Also:

getDescendingAction()