com.adobe.idp.taskmanager.dsc.client.query
Interface SortOrder

All Superinterfaces:

java.io.Serializable

public interface SortOrder
extends java.io.Serializable

The <SortOrder> object is used to set sort criteria on certain query operations. It can sort on up to two columns included in its definitions. The sort columns are defined as ColumnInfo objects and are the only vehicle that can be used to select a column for sorting.

Field Summary

static int	ASCENDING Sort the result set in ascending order on the associated attribute.
static ColumnInfoImpl	ASSIGNMENT_TIME The assignment time column.
static ColumnInfoImpl	ATTACHMENTS The attachments column.
static ColumnInfoImpl	CREATION_TIME The creation time column.
static int	DESCENDING Sort the result set in descending order on the associated attribute.
static ColumnInfoImpl	ID The identifier column.
static ColumnInfoImpl	INSTRUCTIONS The instructions column.
static ColumnInfoImpl	NEW_ASSIGNMENT_TIME The new assignment column.
static ColumnInfoImpl	REMINDER_COUNT The reminder count column.
static ColumnInfoImpl	STATUS The status column.
static ColumnInfoImpl	TITLE The title column.
static ColumnInfoImpl	UPDATE_TIME The update time column.

Method Summary

int	getPrimarySort() Retrieves the direction of the primary sort.
int	getSecondarySort() Retrieves the direction of the secondary sort (ascending or descending).
boolean	isPrimarySortEmpty() Determines whether the primary search criteria have been set.
boolean	isSecondarySortEmpty() Determines whether the secondary search criteria has been set.
void	setPrimarySortCriteria(ColumnInfo PrimaryColumn, int PrimarySort) Sets the primary sort column in the specified order.
void	setSecondarySortCriteria(ColumnInfo SecondaryColumn, int SecondarySort) Sets the secondary sort column for the desired order.

Field Detail

ASCENDING

static final int ASCENDING

Sort the result set in ascending order on the associated attribute.

See Also:

Constant Field Values

DESCENDING

static final int DESCENDING

Sort the result set in descending order on the associated attribute.

See Also:

Constant Field Values

NEW_ASSIGNMENT_TIME

static final ColumnInfoImpl NEW_ASSIGNMENT_TIME

The new assignment column.

ASSIGNMENT_TIME

static final ColumnInfoImpl ASSIGNMENT_TIME

The assignment time column.

TITLE

static final ColumnInfoImpl TITLE

The title column.

STATUS

static final ColumnInfoImpl STATUS

The status column.

CREATION_TIME

static final ColumnInfoImpl CREATION_TIME

The creation time column.

UPDATE_TIME

static final ColumnInfoImpl UPDATE_TIME

The update time column.

REMINDER_COUNT

static final ColumnInfoImpl REMINDER_COUNT

The reminder count column.

ATTACHMENTS

static final ColumnInfoImpl ATTACHMENTS

The attachments column.

ID

static final ColumnInfoImpl ID

The identifier column.

INSTRUCTIONS

static final ColumnInfoImpl INSTRUCTIONS

The instructions column.

Method Detail

setPrimarySortCriteria

void setPrimarySortCriteria(ColumnInfo PrimaryColumn,
                            int PrimarySort)

Sets the primary sort column in the specified order.

Parameters:

PrimaryColumn - The column object on which to base the sort order.

PrimarySort - Indicates whether to sort in ascending or descending order.

setSecondarySortCriteria

void setSecondarySortCriteria(ColumnInfo SecondaryColumn,
                              int SecondarySort)

Sets the secondary sort column for the desired order. The secondary sort criteria need not be set. If this criteria is set however, the primary sort criteria must be set as well or the sorting operation is ignored.

Parameters:

SecondaryColumn - The column object on which to base the sort order.

SecondarySort - Indicates whether to sort in ascending or descending order.

getPrimarySort

int getPrimarySort()

Retrieves the direction of the primary sort.

Returns:

An integer value representing the sort direction. Its value can be either SortOrder.ASCENDING or SortOrder.DESCENDING, with a default of SortOrder.DESCENDING.

getSecondarySort

int getSecondarySort()

Retrieves the direction of the secondary sort (ascending or descending).

Returns:

An integer value representing the sort direction. Its value can be either SortOrder.ASCENDING or SortOrder.DESCENDING, with a default of SortOrder.DESCENDING.

isPrimarySortEmpty

boolean isPrimarySortEmpty()

Determines whether the primary search criteria have been set.

Returns:

true if the primary sort has not been set, false if the primary sort has been set.

isSecondarySortEmpty

boolean isSecondarySortEmpty()

Determines whether the secondary search criteria has been set.

Returns:

true if the secondary sort has not been set, false if the secondary sort has been set.