com.canto.cumulus

Class SortFieldDescriptor

java.lang.Object

com.canto.cumulus.SortFieldDescriptor

public class SortFieldDescriptor
extends java.lang.Object

The information about a single sorting field. It contains the field's unique ID as well as the sorting direction.

Since:

8.1

Constructor Summary

Constructors

Constructor and Description
SortFieldDescriptor(GUID fieldUID, SortDirection sortDirection) Create a new descriptor for a given field and sorting direction.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
GUID	getFieldUID() Get the unique ID of the field to sort by.
SortDirection	getSortDirection() Get the direction to sort this field by.
void	reverseSortDirection() Calling this method reverses the sort direction.
void	setFieldUID(GUID fieldUID) Set the unique ID of the field to sort by.
void	setSortDirection(SortDirection sortDirection) Set the direction to sort this field by.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SortFieldDescriptor

public SortFieldDescriptor(GUID fieldUID,
                   SortDirection sortDirection)

Create a new descriptor for a given field and sorting direction.

Parameters:

fieldUID - The unique ID of the field

sortDirection - the direction to sort by

Method Detail

getFieldUID

public GUID getFieldUID()

Get the unique ID of the field to sort by.

Returns:

The unique ID of the field.

setFieldUID

public void setFieldUID(GUID fieldUID)

Set the unique ID of the field to sort by.

Parameters:

fieldUID - The unique ID of the field.

getSortDirection

public SortDirection getSortDirection()

Get the direction to sort this field by.

Returns:

The sorting direction.

setSortDirection

public void setSortDirection(SortDirection sortDirection)

Set the direction to sort this field by.

Parameters:

sortDirection - The sorting direction.

reverseSortDirection

public void reverseSortDirection()

Calling this method reverses the sort direction.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object