Project: stp

com.ibm.rational.wvcm.stp.cq
Enum CqQuery.DisplayField.SortType

Object
  extended by Enum<CqQuery.DisplayField.SortType>
      extended by CqQuery.DisplayField.SortType
All Implemented Interfaces:
com.ibm.rational.wvcm.stpex.StpExEnumeration, Serializable, Comparable<CqQuery.DisplayField.SortType>
Enclosing interface:
CqQuery.DisplayField

public static enum CqQuery.DisplayField.SortType
extends Enum<CqQuery.DisplayField.SortType>
implements com.ibm.rational.wvcm.stpex.StpExEnumeration

Supported DisplayField sort options


Enum Constant Summary
ASCENDING
          The display field values are sorted in ascending order
DESCENDING
          The display field values are sorted in descending order
NO_SORT
          The display field does not participate in sorting the result set
 
Method Summary
static CqQuery.DisplayField.SortType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CqQuery.DisplayField.SortType[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ASCENDING

public static final CqQuery.DisplayField.SortType ASCENDING
The display field values are sorted in ascending order


DESCENDING

public static final CqQuery.DisplayField.SortType DESCENDING
The display field values are sorted in descending order


NO_SORT

public static final CqQuery.DisplayField.SortType NO_SORT
The display field does not participate in sorting the result set

Method Detail

valueOf

public static CqQuery.DisplayField.SortType 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

values

public static final CqQuery.DisplayField.SortType[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(CqQuery.DisplayField.SortType c : CqQuery.DisplayField.SortType.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

Generated Wed 20-Apr-2011 11:26 AM

Copyright © IBM 2011. All rights reserved.