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

Enum Class WsGetSubjectsResults.WsGetSubjectsResultsCode

java.lang.Object

java.lang.Enum<WsGetSubjectsResults.WsGetSubjectsResultsCode>

edu.internet2.middleware.grouper.ws.coresoap.WsGetSubjectsResults.WsGetSubjectsResultsCode

All Implemented Interfaces:

WsResultCode, Serializable, Comparable<WsGetSubjectsResults.WsGetSubjectsResultsCode>, Constable

Enclosing class:

WsGetSubjectsResults

public static enum WsGetSubjectsResults.WsGetSubjectsResultsCode
extends Enum<WsGetSubjectsResults.WsGetSubjectsResultsCode>
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	something bad happened (lite http status code 500) (success: F)
GROUP_NOT_FOUND	cant find group (lite http status code 500) (success: F)
INSUFFICIENT_PRIVILEGES	if one request, and that is a insufficient privileges (rest http status code 403) (success: F)
INVALID_QUERY	bad input (lite http status code 500) (success: F)
SUCCESS	found the subject results [at least one, look at each one for individual results, if no successes, this will not be success] (lite http status code 200) (success: T)
TOO_MANY_GROUP_FILTER_RESULTS	if a search string generates too many results (less than other too many, e.g.
TOO_MANY_RESULTS	if a search string generates too many results (lite http status code 500) (success: F)

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 WsGetSubjectsResults.WsGetSubjectsResultsCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WsGetSubjectsResults.WsGetSubjectsResultsCode[]	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

GROUP_NOT_FOUND

public static final WsGetSubjectsResults.WsGetSubjectsResultsCode GROUP_NOT_FOUND

cant find group (lite http status code 500) (success: F)

SUCCESS

public static final WsGetSubjectsResults.WsGetSubjectsResultsCode SUCCESS

found the subject results [at least one, look at each one for individual results, if no successes, this will not be success] (lite http status code 200) (success: T)

INVALID_QUERY

public static final WsGetSubjectsResults.WsGetSubjectsResultsCode INVALID_QUERY

bad input (lite http status code 500) (success: F)

TOO_MANY_RESULTS

public static final WsGetSubjectsResults.WsGetSubjectsResultsCode TOO_MANY_RESULTS

if a search string generates too many results (lite http status code 500) (success: F)

TOO_MANY_GROUP_FILTER_RESULTS

public static final WsGetSubjectsResults.WsGetSubjectsResultsCode TOO_MANY_GROUP_FILTER_RESULTS

if a search string generates too many results (less than other too many, e.g. 1000 results) (lite http status code 500) (success: F)

EXCEPTION

public static final WsGetSubjectsResults.WsGetSubjectsResultsCode EXCEPTION

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

INSUFFICIENT_PRIVILEGES

public static final WsGetSubjectsResults.WsGetSubjectsResultsCode INSUFFICIENT_PRIVILEGES

if one request, and that is a insufficient privileges (rest http status code 403) (success: F)

Method Details

values

public static WsGetSubjectsResults.WsGetSubjectsResultsCode[] 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 WsGetSubjectsResults.WsGetSubjectsResultsCode 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:

name

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