edu.internet2.middleware.grouper.ws.coresoap

Enum WsGetPermissionAssignmentsResults.WsGetPermissionAssignmentsResultsCode

java.lang.Object

java.lang.Enum<WsGetPermissionAssignmentsResults.WsGetPermissionAssignmentsResultsCode>

edu.internet2.middleware.grouper.ws.coresoap.WsGetPermissionAssignmentsResults.WsGetPermissionAssignmentsResultsCode

All Implemented Interfaces:

WsResultCode, java.io.Serializable, java.lang.Comparable<WsGetPermissionAssignmentsResults.WsGetPermissionAssignmentsResultsCode>

Enclosing class:

WsGetPermissionAssignmentsResults

public static enum WsGetPermissionAssignmentsResults.WsGetPermissionAssignmentsResultsCode
extends java.lang.Enum<WsGetPermissionAssignmentsResults.WsGetPermissionAssignmentsResultsCode>
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)

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCEPTION something bad happened (lite status code 500) (success: F)
INSUFFICIENT_PRIVILEGES not allowed to the privileges on the inputs.
INVALID_QUERY invalid query (e.g.
SUCCESS found the attributeAssignments (lite status code 200) (success: T)

Method Summary

Modifier and Type	Method and Description
int	getHttpStatusCode() get the http result code for this status code
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 WsGetPermissionAssignmentsResults.WsGetPermissionAssignmentsResultsCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WsGetPermissionAssignmentsResults.WsGetPermissionAssignmentsResultsCode[]	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 WsGetPermissionAssignmentsResults.WsGetPermissionAssignmentsResultsCode SUCCESS

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

EXCEPTION

public static final WsGetPermissionAssignmentsResults.WsGetPermissionAssignmentsResultsCode EXCEPTION

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

INVALID_QUERY

public static final WsGetPermissionAssignmentsResults.WsGetPermissionAssignmentsResultsCode INVALID_QUERY

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

INSUFFICIENT_PRIVILEGES

public static final WsGetPermissionAssignmentsResults.WsGetPermissionAssignmentsResultsCode INSUFFICIENT_PRIVILEGES

not allowed to the privileges on the inputs. Note if broad search, then the results wont contain items not allowed. If a specific search e.g. on a group, then if you cant read the group then you cant read the privs

Method Detail

values

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

Returns:

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

valueOf

public static WsGetPermissionAssignmentsResults.WsGetPermissionAssignmentsResultsCode 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:

name

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