edu.internet2.middleware.grouper.ws.coresoap

Enum WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode

java.lang.Object

java.lang.Enum<WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode>

edu.internet2.middleware.grouper.ws.coresoap.WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode

All Implemented Interfaces:

WsResultCode, java.io.Serializable, java.lang.Comparable<WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode>

Enclosing class:

WsGetGrouperPrivilegesLiteResult

public static enum WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode
extends java.lang.Enum<WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode>
implements WsResultCode

result code of a request

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCEPTION some exception occurred (rest http status code 500) (success: F)
GROUP_NOT_FOUND cant find group (rest http status code 404) (success: F)
INSUFFICIENT_PRIVILEGES if one request, and that is a insufficient privileges (rest http status code 403) (success: F)
INVALID_QUERY invalid query (e.g.
NAME_NOT_FOUND cant find name (rest http status code 404) (success: F)
STEM_NOT_FOUND cant find stem (rest http status code 404) (success: F)
SUBJECT_DUPLICATE if one request, and that is a duplicate (rest http status code 409) (success: F)
SUBJECT_NOT_FOUND if one request, and that is a subject not found (rest http status code 404) (success: F)
SUCCESS didnt have problems (rest http status code 200) (success: T)
SUCCESS_ALLOWED didnt have problems, queried for one privilege, and it is allowed (rest http status code 200) (success: T)
SUCCESS_NOT_ALLOWED didnt have problems, queried for one privilege, and it wasnt allowed (rest http status code 200) (success: T)
TYPE_NOT_FOUND cant find type (rest http status code 404) (success: F)

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 WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode[]	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 WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode SUCCESS

didnt have problems (rest http status code 200) (success: T)

SUCCESS_ALLOWED

public static final WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode SUCCESS_ALLOWED

didnt have problems, queried for one privilege, and it is allowed (rest http status code 200) (success: T)

SUCCESS_NOT_ALLOWED

public static final WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode SUCCESS_NOT_ALLOWED

didnt have problems, queried for one privilege, and it wasnt allowed (rest http status code 200) (success: T)

EXCEPTION

public static final WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode EXCEPTION

some exception occurred (rest http status code 500) (success: F)

SUBJECT_DUPLICATE

public static final WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode SUBJECT_DUPLICATE

if one request, and that is a duplicate (rest http status code 409) (success: F)

SUBJECT_NOT_FOUND

public static final WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode SUBJECT_NOT_FOUND

if one request, and that is a subject not found (rest http status code 404) (success: F)

GROUP_NOT_FOUND

public static final WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode GROUP_NOT_FOUND

cant find group (rest http status code 404) (success: F)

STEM_NOT_FOUND

public static final WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode STEM_NOT_FOUND

cant find stem (rest http status code 404) (success: F)

TYPE_NOT_FOUND

public static final WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode TYPE_NOT_FOUND

cant find type (rest http status code 404) (success: F)

NAME_NOT_FOUND

public static final WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode NAME_NOT_FOUND

cant find name (rest http status code 404) (success: F)

INSUFFICIENT_PRIVILEGES

public static final WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode INSUFFICIENT_PRIVILEGES

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

INVALID_QUERY

public static final WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode INVALID_QUERY

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

Method Detail

values

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

Returns:

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

valueOf

public static WsGetGrouperPrivilegesLiteResult.WsGetGrouperPrivilegesLiteResultCode 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()