org.rhq.core.domain.criteria
Enum Criteria.Restriction

java.lang.Object
  java.lang.Enum<Criteria.Restriction>
      org.rhq.core.domain.criteria.Criteria.Restriction

All Implemented Interfaces:

Serializable, Comparable<Criteria.Restriction>

Enclosing class:

Criteria

public static enum Criteria.Restriction
extends Enum<Criteria.Restriction>

Apply a restriction to reduce the cost of the Criteria-based query generation and execution routines.

Enum Constant Summary

COLLECTION_ONLY
This will return the PageList result whose PageList.isUnbounded() returned true, meaning that the value contained within PageList.getTotalSize() is invalid / undefined.

COUNT_ONLY
This returns an empty PageList result whose PageList.getTotalSize() method otherwise contains the correct value.

Method Summary

static Criteria.Restriction	valueOf(String name) Returns the enum constant of this type with the specified name.
static Criteria.Restriction[]	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

COUNT_ONLY

public static final Criteria.Restriction COUNT_ONLY

This returns an empty PageList result whose PageList.getTotalSize() method otherwise contains the correct value.

COLLECTION_ONLY

public static final Criteria.Restriction COLLECTION_ONLY

This will return the PageList result whose PageList.isUnbounded() returned true, meaning that the value contained within PageList.getTotalSize() is invalid / undefined.

Method Detail

values

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

Returns:

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

valueOf

public static Criteria.Restriction 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