Project: stp

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

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

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

The functions that can be applied to a DisplayField of type DATE_TIME


Enum Constant Summary
DAY
          The day portion of the field value.
MONTH
          The first of the month.
NONE
          No function has been associated with this field
WEEK
          The week number of the year and the year, separated by a comma.
YEAR
          The date that is the first of the year.
 
Method Summary
static CqQuery.DisplayField.Function valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CqQuery.DisplayField.Function[] 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

DAY

public static final CqQuery.DisplayField.Function DAY
The day portion of the field value. For example, 8/29/2002.


MONTH

public static final CqQuery.DisplayField.Function MONTH
The first of the month. For example, 8/1/2002 for the field value, 8/29/2002.


NONE

public static final CqQuery.DisplayField.Function NONE
No function has been associated with this field


WEEK

public static final CqQuery.DisplayField.Function WEEK
The week number of the year and the year, separated by a comma. For example, 35,2002 for 8/29/2002 (the 35th week of the year).


YEAR

public static final CqQuery.DisplayField.Function YEAR
The date that is the first of the year. For example, 1/1/2002 for the field value, 8/29/2002.

Method Detail

valueOf

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

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

Generated Wed 8-Apr-2015 01:06 AM

Copyright © IBM 2015. All rights reserved.