com.tridion.broker.querying.sorting

Class SortParameter

java.lang.Object

com.tridion.broker.querying.sorting.SortParameter

public class SortParameter
extends Object

This is a sorting parameter used to order results in the BrokerQuerying.

Field Summary

Fields

Modifier and Type	Field and Description
static SortDirection	ASCENDING This represents ASCENDING ordering of the results.
static SortDirection	DESCENDING This represents DESCENDING ordering of the results.
static SortColumn	ITEMS_CREATION_DATE Creation date.
static SortColumn	ITEMS_FILENAME Filename.
static SortColumn	ITEMS_INITIAL_PUBLICATION_DATE Initial publication date.
static SortColumn	ITEMS_ITEM_REFERENCE_ID Item reference ID.
static SortColumn	ITEMS_ITEM_TYPE Item type.
static SortColumn	ITEMS_LAST_PUBLISHED_DATE Last published date.
static SortColumn	ITEMS_MAJOR_VERSION Major version.
static SortColumn	ITEMS_MINOR_VERSION Minor version.
static SortColumn	ITEMS_MODIFICATION_DATE Modification date.
static SortColumn	ITEMS_OWNING_PUBLICATION_ID Owning publication ID.
static SortColumn	ITEMS_PAGE_TEMPLATE_ID Page template ID.
static SortColumn	ITEMS_PUBLICATION_ID Publication ID.
static SortColumn	ITEMS_SCHEMA_ID Schema ID.
static SortColumn	ITEMS_TITLE Title.
static SortColumn	ITEMS_TRUSTEE Trustee.
static SortColumn	ITEMS_URL URL.
static SortColumn	PUBLICATIONS_TITLE Publication title.

Constructor Summary

Constructors

Constructor and Description
SortParameter(SortColumn sortColumn, SortDirection sortingDirection) Constructs a SortParameter for a specified field in a certain sorting order.

Method Summary

Modifier and Type	Method and Description
SortColumn	getSortingColumn() Returns the sorting column to sort on for the results.
SortDirection	getSortingDirection() Returns the direction on which to sort the results.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ITEMS_ITEM_REFERENCE_ID

public static final SortColumn ITEMS_ITEM_REFERENCE_ID

Item reference ID.

ITEMS_PUBLICATION_ID

public static final SortColumn ITEMS_PUBLICATION_ID

Publication ID.

ITEMS_MAJOR_VERSION

public static final SortColumn ITEMS_MAJOR_VERSION

Major version.

ITEMS_MINOR_VERSION

public static final SortColumn ITEMS_MINOR_VERSION

Minor version.

ITEMS_OWNING_PUBLICATION_ID

public static final SortColumn ITEMS_OWNING_PUBLICATION_ID

Owning publication ID.

ITEMS_ITEM_TYPE

public static final SortColumn ITEMS_ITEM_TYPE

Item type.

ITEMS_TITLE

public static final SortColumn ITEMS_TITLE

Title.

ITEMS_CREATION_DATE

public static final SortColumn ITEMS_CREATION_DATE

Creation date.

ITEMS_INITIAL_PUBLICATION_DATE

public static final SortColumn ITEMS_INITIAL_PUBLICATION_DATE

Initial publication date.

ITEMS_LAST_PUBLISHED_DATE

public static final SortColumn ITEMS_LAST_PUBLISHED_DATE

Last published date.

ITEMS_TRUSTEE

public static final SortColumn ITEMS_TRUSTEE

Trustee.

ITEMS_MODIFICATION_DATE

public static final SortColumn ITEMS_MODIFICATION_DATE

Modification date.

ITEMS_FILENAME

public static final SortColumn ITEMS_FILENAME

Filename.

ITEMS_PAGE_TEMPLATE_ID

public static final SortColumn ITEMS_PAGE_TEMPLATE_ID

Page template ID.

ITEMS_URL

public static final SortColumn ITEMS_URL

URL.

ITEMS_SCHEMA_ID

public static final SortColumn ITEMS_SCHEMA_ID

Schema ID.

PUBLICATIONS_TITLE

public static final SortColumn PUBLICATIONS_TITLE

Publication title.

ASCENDING

public static final SortDirection ASCENDING

This represents ASCENDING ordering of the results.

DESCENDING

public static final SortDirection DESCENDING

This represents DESCENDING ordering of the results.

Constructor Detail

SortParameter

public SortParameter(SortColumn sortColumn,
                     SortDirection sortingDirection)

Constructs a SortParameter for a specified field in a certain sorting order.

Parameters:

sortColumn - The column to sort on

sortingDirection - The direction to sort the results on

Method Detail

getSortingColumn

public SortColumn getSortingColumn()

Returns the sorting column to sort on for the results.

Returns:

The sorting column to sort of for the results

getSortingDirection

public SortDirection getSortingDirection()

Returns the direction on which to sort the results.

Returns:

The direction on which to sort the results

toString

public String toString()

Overrides:

toString in class Object