edu.internet2.middleware.grouperClient.ws

Enum WsMemberFilter

java.lang.Object

java.lang.Enum<WsMemberFilter>

edu.internet2.middleware.grouperClient.ws.WsMemberFilter

All Implemented Interfaces:

Serializable, Comparable<WsMemberFilter>

public enum WsMemberFilter
extends Enum<WsMemberFilter>

member filter for retrieving members.

Enum Constant Summary

Enum Constants

Enum Constant and Description
All retrieve all members (immediate, effective and composite)
Composite if this is a composite group, then return all the memberships that match the composite operator (union, intersection, complement).
Effective retrieve members which exist due a group as a member of another group (for composite groups, this will not return anything)
Immediate return only direct members of a group (for composite groups this will not return anything)
NonImmediate return only non direct members of a group (will return effective, composite, etc)

Method Summary

Methods

Modifier and Type	Method and Description
static WsMemberFilter	valueOf(String name) Returns the enum constant of this type with the specified name.
static WsMemberFilter	valueOfIgnoreCase(String string) do a case-insensitive matching
static WsMemberFilter[]	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

All

public static final WsMemberFilter All

retrieve all members (immediate, effective and composite)

Effective

public static final WsMemberFilter Effective

retrieve members which exist due a group as a member of another group (for composite groups, this will not return anything)

Immediate

public static final WsMemberFilter Immediate

return only direct members of a group (for composite groups this will not return anything)

NonImmediate

public static final WsMemberFilter NonImmediate

return only non direct members of a group (will return effective, composite, etc)

Composite

public static final WsMemberFilter Composite

if this is a composite group, then return all the memberships that match the composite operator (union, intersection, complement). This will be the same as All for composite groups.

Method Detail

values

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

Returns:

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

valueOf

public static WsMemberFilter valueOf(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:

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

NullPointerException - if the argument is null

valueOfIgnoreCase

public static WsMemberFilter valueOfIgnoreCase(String string)

do a case-insensitive matching

Parameters:

string -

Returns:

the enum or null or exception if not found