| Package | com.adobe.idp.taskmanager.dsc.client.query |
| Interface | 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.
| Package | com.adobe.repository.query.sort |
| Class | public class SortOrder |
| Inheritance | SortOrder  Object |
SQL ORDER BY clause, which is used with com.adobe.repository.query.Query objects. It can be used as shown in the following example: final boolean ASCENDING = true; final boolean DESCENDING = false; SortOrder so = new SortOrder(); so.addSortElement(new SortOrder.Element(Resource.ATTRIBUTE_NAME, ASCENDING)); so.addSortElement(new SortOrder.Element(Resource.ATTRIBUTE_MAJOR_VERSION, DESCENDING)); so.addSortElement(new SortOrder.Element(Resource.ATTRIBUTE_MINOR_VERSION, DESCENDING));
| Method | Defined By | ||
|---|---|---|---|
int getPrimarySort() Retrieves the direction of the primary sort. | SortOrder | ||
int getSecondarySort() Retrieves the direction of the secondary sort (ascending or descending). | SortOrder | ||
boolean isPrimarySortEmpty() Determines whether the primary search criteria have been set. | SortOrder | ||
boolean isSecondarySortEmpty() Determines whether the secondary search criteria has been set. | SortOrder | ||
void setPrimarySortCriteria(ColumnInfo PrimaryColumn, int PrimarySort) Sets the primary sort column in the specified order. | SortOrder | ||
void setSecondarySortCriteria(ColumnInfo SecondaryColumn, int SecondarySort) Sets the secondary sort column for the desired order. | SortOrder | ||
| Method | Defined By | ||
|---|---|---|---|
Default constructor that creates a new, empty SortOrder object. | SortOrder | ||
void addSortElement(Element element) Appends a SortOrder.Element to the list of sorts applied to the query. | SortOrder | ||
void clearSortOrder() Removes all the elements that exist in this object. | SortOrder | ||
List getSortOrder() Retrieves the list of sort order elements. | SortOrder | ||
| Constant | Defined By | ||
|---|---|---|---|
| ASCENDING [static] Sort the result set in ascending order on the associated attribute. | SortOrder | ||
| ASSIGNMENT_TIME [static] The assignment time column. | SortOrder | ||
| ATTACHMENTS [static] The attachments column. | SortOrder | ||
| CREATION_TIME [static] The creation time column. | SortOrder | ||
| DESCENDING [static] Sort the result set in descending order on the associated attribute. | SortOrder | ||
| ID [static] The identifier column. | SortOrder | ||
| INSTRUCTIONS [static] The instructions column. | SortOrder | ||
| NEW_ASSIGNMENT_TIME [static] The new assignment column. | SortOrder | ||
| REMINDER_COUNT [static] The reminder count column. | SortOrder | ||
| STATUS [static] The status column. | SortOrder | ||
| TITLE [static] The title column. | SortOrder | ||
| UPDATE_TIME [static] The update time column. | SortOrder | ||
| SortOrder | () |
public SortOrder()Default constructor that creates a new, empty SortOrder object.
| getPrimarySort | () |
public int getPrimarySort()Retrieves the direction of the primary sort.
Returns| An integer value representing the sort direction. Its value can be either ASCENDING or DESCENDING, with a default of DESCENDING. |
| getSecondarySort | () |
public 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 ASCENDING or DESCENDING, with a default of DESCENDING. |
| isPrimarySortEmpty | () |
public boolean isPrimarySortEmpty()Determines whether the primary search criteria have been set.
Returnstrue if the primary sort has not been set, false if the primary sort has been set. |
| isSecondarySortEmpty | () |
public boolean isSecondarySortEmpty()Determines whether the secondary search criteria has been set.
Returnstrue if the secondary sort has not been set, false if the secondary sort has been set. |
| setPrimarySortCriteria | () |
public 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 | () |
public 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. |
| addSortElement | () |
public void addSortElement(Element element)Appends a SortOrder.Element to the list of sorts applied to the query.
Parameters
element — A SortOrder.Element instance representing the sort order element. |
| clearSortOrder | () |
public void clearSortOrder()Removes all the elements that exist in this object.
| getSortOrder | () |
public List getSortOrder()Retrieves the list of sort order elements.
Returns| An ordered list of SortOrder.Element objects, stored in the order they were added. |
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/repository/query/sort/SortOrder.html