org.axsl.common.value

Enum RetrieveBoundaryWithinTable

java.lang.Object

java.lang.Enum<RetrieveBoundaryWithinTable>

org.axsl.common.value.RetrieveBoundaryWithinTable

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RetrieveBoundaryWithinTable>

public enum RetrieveBoundaryWithinTable
extends java.lang.Enum<RetrieveBoundaryWithinTable>

Enumeration of possible "retrieve-boundary-within-table" values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PAGE The retrieve scope area set is limited to the primary scope area and the retrieve scope areas that both precede this primary retrieve scope and are on the same page as the primary retrieve scope area.
TABLE The retrieve scope area set is limited to the primary retrieve scope area and the retrieve scope areas that precede the primary retrieve scope area.
TABLE_FRAGMENT The retrieve scope area set is limited to the primary retrieve scope area.

Method Summary

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

TABLE

public static final RetrieveBoundaryWithinTable TABLE

The retrieve scope area set is limited to the primary retrieve scope area and the retrieve scope areas that precede the primary retrieve scope area.

TABLE_FRAGMENT

public static final RetrieveBoundaryWithinTable TABLE_FRAGMENT

The retrieve scope area set is limited to the primary retrieve scope area.

PAGE

public static final RetrieveBoundaryWithinTable PAGE

The retrieve scope area set is limited to the primary scope area and the retrieve scope areas that both precede this primary retrieve scope and are on the same page as the primary retrieve scope area.

Method Detail

values

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

Returns:

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

valueOf

public static RetrieveBoundaryWithinTable valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null