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

Enum Class WsFindGroupsResults.WsFindGroupsResultsCode

java.lang.Object

java.lang.Enum<WsFindGroupsResults.WsFindGroupsResultsCode>

edu.internet2.middleware.grouper.ws.coresoap.WsFindGroupsResults.WsFindGroupsResultsCode

All Implemented Interfaces:

WsResultCode, Serializable, Comparable<WsFindGroupsResults.WsFindGroupsResultsCode>, Constable

Enclosing class:

WsFindGroupsResults

public static enum WsFindGroupsResults.WsFindGroupsResultsCode
extends Enum<WsFindGroupsResults.WsFindGroupsResultsCode>
implements WsResultCode

result code of a request

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	found the subject (lite http status code 500) (success: F)
INVALID_QUERY	invalid query (e.g.
STEM_NOT_FOUND	cant find the stem in a stem search (lite http status code 404) (success: F)
SUCCESS	found the subject (lite http status code 200) (success: T)

Method Summary

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

found the subject (lite http status code 200) (success: T)

EXCEPTION

public static final WsFindGroupsResults.WsFindGroupsResultsCode EXCEPTION

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

INVALID_QUERY

public static final WsFindGroupsResults.WsFindGroupsResultsCode INVALID_QUERY

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

STEM_NOT_FOUND

public static final WsFindGroupsResults.WsFindGroupsResultsCode STEM_NOT_FOUND

cant find the stem in a stem search (lite http status code 404) (success: F)

Method Details

values

public static WsFindGroupsResults.WsFindGroupsResultsCode[] 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 WsFindGroupsResults.WsFindGroupsResultsCode 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:

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

isSuccess

public boolean isSuccess()

if this is a successful result

Specified by:

isSuccess in interface WsResultCode

Returns:

true if success