Package edu.internet2.middleware.grouper.ws.query

Enum Class GroupQueryScope

java.lang.Object

java.lang.Enum<GroupQueryScope>

edu.internet2.middleware.grouper.ws.query.GroupQueryScope

All Implemented Interfaces:

Serializable, Comparable<GroupQueryScope>, Constable

public enum GroupQueryScope
extends Enum<GroupQueryScope>

scope of a group query (which attribute to look in or all)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	all of these attributes
DISPLAY_EXTENSION	friendly version of extension
DISPLAY_NAME	friendly version of name
EXTENSION	search extension (right part of name)
NAME	search group name: a:b:c

Method Summary

Modifier and Type	Method	Description
static GroupQueryScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GroupQueryScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final GroupQueryScope ALL

all of these attributes

NAME

public static final GroupQueryScope NAME

search group name: a:b:c

EXTENSION

public static final GroupQueryScope EXTENSION

search extension (right part of name)

DISPLAY_NAME

public static final GroupQueryScope DISPLAY_NAME

friendly version of name

DISPLAY_EXTENSION

public static final GroupQueryScope DISPLAY_EXTENSION

friendly version of extension

Method Details

values

public static GroupQueryScope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static GroupQueryScope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null