org.xwiki.ratings

Enum RatingsManager.RatingQueryField

java.lang.Object

java.lang.Enum<RatingsManager.RatingQueryField>

org.xwiki.ratings.RatingsManager.RatingQueryField

All Implemented Interfaces:

Serializable, Comparable<RatingsManager.RatingQueryField>

Enclosing interface:

RatingsManager

public static enum RatingsManager.RatingQueryField
extends Enum<RatingsManager.RatingQueryField>

The fields to be used for performing queries on Ratings.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATED_DATE Represents the 'createdDate' field.
ENTITY_REFERENCE Represents the 'id' field.
IDENTIFIER Represents the 'id' field.
MANAGER_ID Represents the 'managerId' field.
PARENTS_REFERENCE Represents the 'parents' field.
SCALE Represents the 'scale' field.
UPDATED_DATE Represents the 'updatedDate' field.
USER_REFERENCE Represents the 'author' field.
VOTE Represents the 'vote' field.

Method Summary

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

IDENTIFIER

public static final RatingsManager.RatingQueryField IDENTIFIER

Represents the 'id' field.

ENTITY_REFERENCE

public static final RatingsManager.RatingQueryField ENTITY_REFERENCE

Represents the 'id' field.

PARENTS_REFERENCE

public static final RatingsManager.RatingQueryField PARENTS_REFERENCE

Represents the 'parents' field.

USER_REFERENCE

public static final RatingsManager.RatingQueryField USER_REFERENCE

Represents the 'author' field.

VOTE

public static final RatingsManager.RatingQueryField VOTE

Represents the 'vote' field.

CREATED_DATE

public static final RatingsManager.RatingQueryField CREATED_DATE

Represents the 'createdDate' field.

UPDATED_DATE

public static final RatingsManager.RatingQueryField UPDATED_DATE

Represents the 'updatedDate' field.

MANAGER_ID

public static final RatingsManager.RatingQueryField MANAGER_ID

Represents the 'managerId' field.

SCALE

public static final RatingsManager.RatingQueryField SCALE

Represents the 'scale' field.

Method Detail

values

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

Returns:

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

valueOf

public static RatingsManager.RatingQueryField 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

getFieldName

public String getFieldName()

Returns:

the name of the field used for filtering Rating queries.