edu.internet2.middleware.grouper.ws.coresoap

Enum WsGetGroupsResults.WsGetGroupsResultsCode

java.lang.Object

java.lang.Enum<WsGetGroupsResults.WsGetGroupsResultsCode>

edu.internet2.middleware.grouper.ws.coresoap.WsGetGroupsResults.WsGetGroupsResultsCode

All Implemented Interfaces:

WsResultCode, java.io.Serializable, java.lang.Comparable<WsGetGroupsResults.WsGetGroupsResultsCode>

Enclosing class:

WsGetGroupsResults

public static enum WsGetGroupsResults.WsGetGroupsResultsCode
extends java.lang.Enum<WsGetGroupsResults.WsGetGroupsResultsCode>
implements WsResultCode

result code of a request

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCEPTION found the subject (rest http status code 500) (success: F)
INVALID_QUERY invalid query (e.g.
PROBLEM_RETRIEVING_GROUPS problem deleting existing members (rest http status code 500) (success: F)
SUCCESS found the subject (rest http status code 201) (success: T) CH 20120210: Why is this a 201???? shouldnt it be 200????

Method Summary

Modifier and Type	Method and Description
int	getHttpStatusCode() get the http status code associated with this status code, e.g.
boolean	isSuccess() if this is a successful result
java.lang.String	nameForVersion(GrouperVersion clientVersion) get the name label for a certain version of client
static WsGetGroupsResults.WsGetGroupsResultsCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WsGetGroupsResults.WsGetGroupsResultsCode[]	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

Methods inherited from interface edu.internet2.middleware.grouper.ws.WsResultCode

name

Enum Constant Detail

SUCCESS

public static final WsGetGroupsResults.WsGetGroupsResultsCode SUCCESS

found the subject (rest http status code 201) (success: T) CH 20120210: Why is this a 201???? shouldnt it be 200????

EXCEPTION

public static final WsGetGroupsResults.WsGetGroupsResultsCode EXCEPTION

found the subject (rest http status code 500) (success: F)

PROBLEM_RETRIEVING_GROUPS

public static final WsGetGroupsResults.WsGetGroupsResultsCode PROBLEM_RETRIEVING_GROUPS

problem deleting existing members (rest http status code 500) (success: F)

INVALID_QUERY

public static final WsGetGroupsResults.WsGetGroupsResultsCode INVALID_QUERY

invalid query (e.g. if everything blank) (rest http status code 400) (success: F)

Method Detail

values

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

Returns:

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

valueOf

public static WsGetGroupsResults.WsGetGroupsResultsCode 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

nameForVersion

public java.lang.String nameForVersion(GrouperVersion clientVersion)

get the name label for a certain version of client

Specified by:

nameForVersion in interface WsResultCode

Parameters:

clientVersion -

Returns:

isSuccess

public boolean isSuccess()

if this is a successful result

Specified by:

isSuccess in interface WsResultCode

Returns:

true if success

getHttpStatusCode

public int getHttpStatusCode()

Description copied from interface: WsResultCode

get the http status code associated with this status code, e.g. 200

Specified by:

getHttpStatusCode in interface WsResultCode

Returns:

the status code e.g. 200

See Also:

WsResultCode.getHttpStatusCode()