Package edu.internet2.middleware.grouper.ws.coresoap

Enum Class WsGetMembersResults.WsGetMembersResultsCode

java.lang.Object

java.lang.Enum<WsGetMembersResults.WsGetMembersResultsCode>

edu.internet2.middleware.grouper.ws.coresoap.WsGetMembersResults.WsGetMembersResultsCode

All Implemented Interfaces:

WsResultCode, Serializable, Comparable<WsGetMembersResults.WsGetMembersResultsCode>, Constable

Enclosing class:

WsGetMembersResults

public static enum WsGetMembersResults.WsGetMembersResultsCode
extends Enum<WsGetMembersResults.WsGetMembersResultsCode>
implements WsResultCode

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

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
EXCEPTION	something bad happened (lite status code 500) (success: F)
INVALID_QUERY	invalid query (e.g.
PROBLEM_GETTING_MEMBERS	something bad happened with some of the member retrieval (lite status code 500) (success: F)
SUCCESS	found the members (lite status code 200) (success: T)

Method Summary

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

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

name

Enum Constant Details

SUCCESS

public static final WsGetMembersResults.WsGetMembersResultsCode SUCCESS

found the members (lite status code 200) (success: T)

EXCEPTION

public static final WsGetMembersResults.WsGetMembersResultsCode EXCEPTION

something bad happened (lite status code 500) (success: F)

PROBLEM_GETTING_MEMBERS

public static final WsGetMembersResults.WsGetMembersResultsCode PROBLEM_GETTING_MEMBERS

something bad happened with some of the member retrieval (lite status code 500) (success: F)

INVALID_QUERY

public static final WsGetMembersResults.WsGetMembersResultsCode INVALID_QUERY

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

Method Details

values

public static WsGetMembersResults.WsGetMembersResultsCode[] 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 WsGetMembersResults.WsGetMembersResultsCode 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

nameForVersion

public 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()

get the http result code for this status code

Specified by:

getHttpStatusCode in interface WsResultCode

Returns:

the status code