edu.internet2.middleware.grouper.ws.coresoap

Enum WsGetMembersResult.WsGetMembersResultCode

java.lang.Object

java.lang.Enum<WsGetMembersResult.WsGetMembersResultCode>

edu.internet2.middleware.grouper.ws.coresoap.WsGetMembersResult.WsGetMembersResultCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WsGetMembersResult.WsGetMembersResultCode>

Enclosing class:

WsGetMembersResult

public static enum WsGetMembersResult.WsGetMembersResultCode
extends java.lang.Enum<WsGetMembersResult.WsGetMembersResultCode>

result code of a request. The possible result codes of WsGetMembersResultCode (with http status codes) are: SUCCESS(200), EXCEPTION(500), INVALID_QUERY(400)

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCEPTION something bad happened
GROUP_NOT_FOUND cant find group
GROUP_UUID_DOESNT_MATCH_NAME if the lookup has both name and uuid, and they dont match
INVALID_QUERY invalid query (e.g.
PROBLEM_GETTING_MEMBERS something bad happened with some of the member retrieval
SUCCESS found the members

Method Summary

Modifier and Type	Method and Description
abstract WsGetMembersLiteResult.WsGetMembersLiteResultCode	convertToLiteCode() if there is one result, convert to the results code
boolean	isSuccess() if this is a successful result
static WsGetMembersResult.WsGetMembersResultCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WsGetMembersResult.WsGetMembersResultCode[]	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

GROUP_NOT_FOUND

public static final WsGetMembersResult.WsGetMembersResultCode GROUP_NOT_FOUND

cant find group

SUCCESS

public static final WsGetMembersResult.WsGetMembersResultCode SUCCESS

found the members

GROUP_UUID_DOESNT_MATCH_NAME

public static final WsGetMembersResult.WsGetMembersResultCode GROUP_UUID_DOESNT_MATCH_NAME

if the lookup has both name and uuid, and they dont match

EXCEPTION

public static final WsGetMembersResult.WsGetMembersResultCode EXCEPTION

something bad happened

PROBLEM_GETTING_MEMBERS

public static final WsGetMembersResult.WsGetMembersResultCode PROBLEM_GETTING_MEMBERS

something bad happened with some of the member retrieval

INVALID_QUERY

public static final WsGetMembersResult.WsGetMembersResultCode INVALID_QUERY

invalid query (e.g. if everything blank)

Method Detail

values

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

Returns:

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

valueOf

public static WsGetMembersResult.WsGetMembersResultCode 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

isSuccess

public boolean isSuccess()

if this is a successful result

Returns:

true if success

convertToLiteCode

public abstract WsGetMembersLiteResult.WsGetMembersLiteResultCode convertToLiteCode()

if there is one result, convert to the results code

Returns:

result code