GroupQueryScope

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

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

java.lang.Object
  java.lang.Enum<GroupQueryScope>
      edu.internet2.middleware.grouper.ws.query.GroupQueryScope

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<GroupQueryScope>

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

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

Enum Constant Summary
`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
`static GroupQueryScope`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static GroupQueryScope[]`	`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

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 Detail

values

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

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

valueOf

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