org.kuali.rice.core.api.criteria

Enum CountFlag

java.lang.Object

java.lang.Enum<CountFlag>

org.kuali.rice.core.api.criteria.CountFlag

All Implemented Interfaces:

Serializable, Comparable<CountFlag>

public enum CountFlag
extends Enum<CountFlag>

Defines possible directives for how a query is requested to produce count values in it's results.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Enum Constant Summary

Enum Constants

Enum Constant and Description
INCLUDE Indicates that the row count of the query should be returned with the query results.
NONE Indicates that no row count should be returned with the query results.
ONLY Indicates that *only* the row count should be returned with the query results.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFlag() Returns the value of the count flag.
static CountFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static CountFlag[]	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

NONE

public static final CountFlag NONE

Indicates that no row count should be returned with the query results.

INCLUDE

public static final CountFlag INCLUDE

Indicates that the row count of the query should be returned with the query results.

ONLY

public static final CountFlag ONLY

Indicates that *only* the row count should be returned with the query results. The result should not include the actual rows returned from the query.

Method Detail

values

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

Returns:

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

valueOf

public static CountFlag 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

getFlag

public String getFlag()

Returns the value of the count flag.

Returns:

the flag