atg.repository

Enum GlobalContextType

java.lang.Object

java.lang.Enum<GlobalContextType>

atg.repository.GlobalContextType

All Implemented Interfaces:

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

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

An enumeration of global filtering context types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL An "ALL" membership context which can be pushed to the stack of contexts, and make it current on a thread.
ANY An "ANY" membership context which can be pushed to the stack of membership contexts, and make it current on a thread.
NONE A "NONE" membership context which can be pushed to the stack of Contexts, and make it current on a thread.

Method Summary

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

ANY

public static final GlobalContextType ANY

An "ANY" membership context which can be pushed to the stack of membership contexts, and make it current on a thread. Using an ANY global context will cause repository calls to only include items which are members of at least one membership context. In other words, all items with an empty membership property will be excluded.

NONE

public static final GlobalContextType NONE

A "NONE" membership context which can be pushed to the stack of Contexts, and make it current on a thread. Use this type when you want repository calls and queries to only include items with an empty membership context property value.

ALL

public static final GlobalContextType ALL

An "ALL" membership context which can be pushed to the stack of contexts, and make it current on a thread. This can be used to temporarily "clear" the active membership contexts, and use a pop to restore the previously active contexts. Since pushing a contexts signals inclusions, this method will act as if all possible contexts have been pushed. You could use this context type to temporarily disable any context filtering

Method Detail

values

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

Returns:

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

valueOf

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