SortColumn (CDaaS - API 8.3.0-1004 API)

java.lang.Object
- java.lang.Enum<SortColumn>
- - com.sdl.web.api.broker.querying.sorting.SortColumn

All Implemented Interfaces:

BrokerSortColumn, Serializable, Comparable<SortColumn>
```
public enum SortColumn
extends Enum<SortColumn>
implements BrokerSortColumn
```
This represents the sorting column which can be used in the broker Query API to sort the result date on.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`COMPONENT_SCHEMA_COLUMN` Component Schema Column.
`ITEM_CREATION_DATE_COLUMN` Item Creation Date Column.
`ITEM_ID` Item Id.
`ITEM_INITIAL_PUBLICATION_COLUMN` Item Initial Publication Column.
`ITEM_LAST_PUBLISH_COLUMN` Item Last Publish Column.
`ITEM_MAJOR_VERSION` Item Major Version.
`ITEM_MINOR_VERSION` Item Minor Version.
`ITEM_MODIFICATION_COLUMN` Item Modification Column.
`ITEM_OWNING_PUBLICATION_ID` Item Owning Publication Id.
`ITEM_PUBLICATION_COLUMN` Item Publication Column.
`ITEM_TITLE_COLUMN` Item Title Column.
`ITEM_TRUSTEE_COLUMN` Item Trustee Column.
`ITEM_TYPE_COLUMN` Item Type Column.
`PAGE_FILENAME_COLUMN` Page Filename Column.
`PAGE_TEMPLATE_COLUMN` Page Template Column.
`PAGE_URL_COLUMN` Page URL Column.
`PUBLICATION_TITLE_COLUMN` Publication Title Column.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SortColumn`	`getSortColumn()` Returns SortColumn enum.
`String`	`getSortingName()` Get a sorting name.
`static SortColumn`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SortColumn[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ITEM_ID
```
public static final SortColumn ITEM_ID
```
    Item Id.
  - ITEM_PUBLICATION_COLUMN
```
public static final SortColumn ITEM_PUBLICATION_COLUMN
```
    Item Publication Column.
  - ITEM_MAJOR_VERSION
```
public static final SortColumn ITEM_MAJOR_VERSION
```
    Item Major Version.
  - ITEM_MINOR_VERSION
```
public static final SortColumn ITEM_MINOR_VERSION
```
    Item Minor Version.
  - ITEM_OWNING_PUBLICATION_ID
```
public static final SortColumn ITEM_OWNING_PUBLICATION_ID
```
    Item Owning Publication Id.
  - ITEM_TYPE_COLUMN
```
public static final SortColumn ITEM_TYPE_COLUMN
```
    Item Type Column.
  - ITEM_TITLE_COLUMN
```
public static final SortColumn ITEM_TITLE_COLUMN
```
    Item Title Column.
  - ITEM_CREATION_DATE_COLUMN
```
public static final SortColumn ITEM_CREATION_DATE_COLUMN
```
    Item Creation Date Column.
  - ITEM_INITIAL_PUBLICATION_COLUMN
```
public static final SortColumn ITEM_INITIAL_PUBLICATION_COLUMN
```
    Item Initial Publication Column.
  - ITEM_LAST_PUBLISH_COLUMN
```
public static final SortColumn ITEM_LAST_PUBLISH_COLUMN
```
    Item Last Publish Column.
  - ITEM_TRUSTEE_COLUMN
```
public static final SortColumn ITEM_TRUSTEE_COLUMN
```
    Item Trustee Column.
  - ITEM_MODIFICATION_COLUMN
```
public static final SortColumn ITEM_MODIFICATION_COLUMN
```
    Item Modification Column.
  - PAGE_FILENAME_COLUMN
```
public static final SortColumn PAGE_FILENAME_COLUMN
```
    Page Filename Column.
  - PAGE_TEMPLATE_COLUMN
```
public static final SortColumn PAGE_TEMPLATE_COLUMN
```
    Page Template Column.
  - PAGE_URL_COLUMN
```
public static final SortColumn PAGE_URL_COLUMN
```
    Page URL Column.
  - COMPONENT_SCHEMA_COLUMN
```
public static final SortColumn COMPONENT_SCHEMA_COLUMN
```
    Component Schema Column.
  - PUBLICATION_TITLE_COLUMN
```
public static final SortColumn PUBLICATION_TITLE_COLUMN
```
    Publication Title Column.
- Method Detail
  - values
```
public static SortColumn[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SortColumn c : SortColumn.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SortColumn valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getSortingName
```
public String getSortingName()
```
    Description copied from interface: BrokerSortColumn
    
    Get a sorting name.
    
    Specified by:
    
    getSortingName in interface BrokerSortColumn
    
    Returns:
    
    sorting name
  - getSortColumn
```
public SortColumn getSortColumn()
```
    Description copied from interface: BrokerSortColumn
    
    Returns SortColumn enum. This is done for serializer because compatible classes that implement this interface are not enums and this causes issues.
    
    Specified by:
    
    getSortColumn in interface BrokerSortColumn
    
    Returns:
    
    SortColumn enum

Enum SortColumn

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ITEM_ID

ITEM_PUBLICATION_COLUMN

ITEM_MAJOR_VERSION

ITEM_MINOR_VERSION

ITEM_OWNING_PUBLICATION_ID

ITEM_TYPE_COLUMN

ITEM_TITLE_COLUMN

ITEM_CREATION_DATE_COLUMN

ITEM_INITIAL_PUBLICATION_COLUMN

ITEM_LAST_PUBLISH_COLUMN

ITEM_TRUSTEE_COLUMN

ITEM_MODIFICATION_COLUMN

PAGE_FILENAME_COLUMN

PAGE_TEMPLATE_COLUMN

PAGE_URL_COLUMN

COMPONENT_SCHEMA_COLUMN

PUBLICATION_TITLE_COLUMN

Method Detail

values

valueOf

getSortingName

getSortColumn