edu.internet2.middleware.grouper.ws.coresoap

Enum WsFindStemsResults.WsFindStemsResultsCode

java.lang.Object

java.lang.Enum<WsFindStemsResults.WsFindStemsResultsCode>

edu.internet2.middleware.grouper.ws.coresoap.WsFindStemsResults.WsFindStemsResultsCode

All Implemented Interfaces:

WsResultCode, Serializable, Comparable<WsFindStemsResults.WsFindStemsResultsCode>

Enclosing class:

WsFindStemsResults

public static enum WsFindStemsResults.WsFindStemsResultsCode
extends Enum<WsFindStemsResults.WsFindStemsResultsCode>
implements WsResultCode

result code of a request

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCEPTION found the subject (lite http status code 500) (success: F)
INVALID_QUERY invalid query (e.g.
PARENT_STEM_NOT_FOUND if the parent was not found in a search by parent (lite http status code 404) (success: F)
SUCCESS found the stem (or not) (lite http status code 200) (success: T)

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
String	nameForVersion(edu.internet2.middleware.grouper.misc.GrouperVersion clientVersion) get the name label for a certain version of client
static WsFindStemsResults.WsFindStemsResultsCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static WsFindStemsResults.WsFindStemsResultsCode[]	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

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

name

Enum Constant Detail

SUCCESS

public static final WsFindStemsResults.WsFindStemsResultsCode SUCCESS

found the stem (or not) (lite http status code 200) (success: T)

EXCEPTION

public static final WsFindStemsResults.WsFindStemsResultsCode EXCEPTION

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

INVALID_QUERY

public static final WsFindStemsResults.WsFindStemsResultsCode INVALID_QUERY

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

PARENT_STEM_NOT_FOUND

public static final WsFindStemsResults.WsFindStemsResultsCode PARENT_STEM_NOT_FOUND

if the parent was not found in a search by parent (lite http status code 404) (success: F)

Method Detail

values

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

Returns:

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

valueOf

public static WsFindStemsResults.WsFindStemsResultsCode 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

nameForVersion

public String nameForVersion(edu.internet2.middleware.grouper.misc.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