Package org.opencms.search.galleries

Enum CmsGallerySearchParameters.CmsGallerySortParam

java.lang.Object

java.lang.Enum<CmsGallerySearchParameters.CmsGallerySortParam>

org.opencms.search.galleries.CmsGallerySearchParameters.CmsGallerySortParam

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsGallerySearchParameters.CmsGallerySortParam>

Enclosing class:

CmsGallerySearchParameters

public static enum CmsGallerySearchParameters.CmsGallerySortParam
extends java.lang.Enum<CmsGallerySearchParameters.CmsGallerySortParam>

Sort parameter constants.

Enum Constant Summary

Enum Constants

Enum Constant	Description
dateCreated_asc	Sort by date created ascending.
dateCreated_desc	Sort by date created descending.
dateExpired_asc	Sort date expired ascending.
dateExpired_desc	Sort date expired descending.
dateLastModified_asc	Sort by date modified ascending.
dateLastModified_desc	Sort by date modified descending.
dateReleased_asc	Sort date released ascending.
dateReleased_desc	Sort date released descending.
length_asc	Sort by length ascending.
length_desc	Sort by length descending.
path_asc	Sort by VFS root path ascending.
path_desc	Sort by VFS root path descending.
score	Sort by score descending.
state_asc	Sort state ascending.
state_desc	Sort state descending.
title_asc	Sort by title ascending.
title_desc	Sort by title ascending.
type_asc	Sort by type ascending.
type_desc	Sort by type descending.
userCreated_asc	Sort created by ascending.
userCreated_desc	Sort created by descending.
userLastModified_asc	Sort modified by ascending.
userLastModified_desc	Sort modified by descending.

Field Summary

Fields

Modifier and Type	Field	Description
static CmsGallerySearchParameters.CmsGallerySortParam	DEFAULT	The default sort parameter.

Method Summary

Modifier and Type	Method	Description
static CmsGallerySearchParameters.CmsGallerySortParam	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static CmsGallerySearchParameters.CmsGallerySortParam[]	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

dateCreated_asc

public static final CmsGallerySearchParameters.CmsGallerySortParam dateCreated_asc

Sort by date created ascending.

dateCreated_desc

public static final CmsGallerySearchParameters.CmsGallerySortParam dateCreated_desc

Sort by date created descending.

dateExpired_asc

public static final CmsGallerySearchParameters.CmsGallerySortParam dateExpired_asc

Sort date expired ascending.

dateExpired_desc

public static final CmsGallerySearchParameters.CmsGallerySortParam dateExpired_desc

Sort date expired descending.

dateLastModified_asc

public static final CmsGallerySearchParameters.CmsGallerySortParam dateLastModified_asc

Sort by date modified ascending.

dateLastModified_desc

public static final CmsGallerySearchParameters.CmsGallerySortParam dateLastModified_desc

Sort by date modified descending.

dateReleased_asc

public static final CmsGallerySearchParameters.CmsGallerySortParam dateReleased_asc

Sort date released ascending.

dateReleased_desc

public static final CmsGallerySearchParameters.CmsGallerySortParam dateReleased_desc

Sort date released descending.

length_asc

public static final CmsGallerySearchParameters.CmsGallerySortParam length_asc

Sort by length ascending.

length_desc

public static final CmsGallerySearchParameters.CmsGallerySortParam length_desc

Sort by length descending.

path_asc

public static final CmsGallerySearchParameters.CmsGallerySortParam path_asc

Sort by VFS root path ascending.

path_desc

public static final CmsGallerySearchParameters.CmsGallerySortParam path_desc

Sort by VFS root path descending.

score

public static final CmsGallerySearchParameters.CmsGallerySortParam score

Sort by score descending.

state_asc

public static final CmsGallerySearchParameters.CmsGallerySortParam state_asc

Sort state ascending.

state_desc

public static final CmsGallerySearchParameters.CmsGallerySortParam state_desc

Sort state descending.

title_asc

public static final CmsGallerySearchParameters.CmsGallerySortParam title_asc

Sort by title ascending.

title_desc

public static final CmsGallerySearchParameters.CmsGallerySortParam title_desc

Sort by title ascending.

type_asc

public static final CmsGallerySearchParameters.CmsGallerySortParam type_asc

Sort by type ascending.

type_desc

public static final CmsGallerySearchParameters.CmsGallerySortParam type_desc

Sort by type descending.

userCreated_asc

public static final CmsGallerySearchParameters.CmsGallerySortParam userCreated_asc

Sort created by ascending.

userCreated_desc

public static final CmsGallerySearchParameters.CmsGallerySortParam userCreated_desc

Sort created by descending.

userLastModified_asc

public static final CmsGallerySearchParameters.CmsGallerySortParam userLastModified_asc

Sort modified by ascending.

userLastModified_desc

public static final CmsGallerySearchParameters.CmsGallerySortParam userLastModified_desc

Sort modified by descending.

Field Detail

DEFAULT

public static final CmsGallerySearchParameters.CmsGallerySortParam DEFAULT

The default sort parameter.

Method Detail

values

public static CmsGallerySearchParameters.CmsGallerySortParam[] 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 (CmsGallerySearchParameters.CmsGallerySortParam c : CmsGallerySearchParameters.CmsGallerySortParam.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CmsGallerySearchParameters.CmsGallerySortParam valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null