edu.internet2.middleware.grouper.ws.query

Enum StemScope

java.lang.Object

java.lang.Enum<StemScope>

edu.internet2.middleware.grouper.ws.query.StemScope

All Implemented Interfaces:

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

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

scope of groups under a stem. either all or just one level (immediate)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_IN_SUBTREE all children in the subtree below the stem
ONE_LEVEL just direct immediate chlidren

Method Summary

Modifier and Type	Method and Description
abstract Scope	convertToScope() convert this to a real Grouper scope
static StemScope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StemScope	valueOfIgnoreCase(java.lang.String string) do a case-insensitive matching
static StemScope[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ONE_LEVEL

public static final StemScope ONE_LEVEL

just direct immediate chlidren

ALL_IN_SUBTREE

public static final StemScope ALL_IN_SUBTREE

all children in the subtree below the stem

Method Detail

values

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

Returns:

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

valueOf

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

valueOfIgnoreCase

public static StemScope valueOfIgnoreCase(java.lang.String string)

do a case-insensitive matching

Parameters:

string -

Returns:

the enum or null or exception if not found

convertToScope

public abstract Scope convertToScope()

convert this to a real Grouper scope

Returns:

the scope