|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SortOrder
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 |
---|
static final int ASCENDING
static final int DESCENDING
static final ColumnInfoImpl NEW_ASSIGNMENT_TIME
static final ColumnInfoImpl ASSIGNMENT_TIME
static final ColumnInfoImpl TITLE
static final ColumnInfoImpl STATUS
static final ColumnInfoImpl CREATION_TIME
static final ColumnInfoImpl UPDATE_TIME
static final ColumnInfoImpl REMINDER_COUNT
static final ColumnInfoImpl ATTACHMENTS
static final ColumnInfoImpl ID
static final ColumnInfoImpl INSTRUCTIONS
Method Detail |
---|
void setPrimarySortCriteria(ColumnInfo PrimaryColumn, int PrimarySort)
PrimaryColumn
- The column object on which to base the sort order.PrimarySort
- Indicates whether to sort in ascending or descending order.void setSecondarySortCriteria(ColumnInfo SecondaryColumn, int SecondarySort)
SecondaryColumn
- The column object on which to base the sort order.SecondarySort
- Indicates whether to sort in ascending or descending order.int getPrimarySort()
SortOrder.ASCENDING
or SortOrder.DESCENDING
, with a default of SortOrder.DESCENDING
.int getSecondarySort()
SortOrder.ASCENDING
or SortOrder.DESCENDING
, with a default of SortOrder.DESCENDING
.boolean isPrimarySortEmpty()
true
if the primary sort has not been set, false
if the primary sort has been set.boolean isSecondarySortEmpty()
true
if the secondary sort has not been set, false
if the secondary sort has been set.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |