edu.internet2.middleware.grouper.ws.coresoap

Enum WsGroupSaveLiteResult.WsGroupSaveLiteResultCode

java.lang.Object

java.lang.Enum<WsGroupSaveLiteResult.WsGroupSaveLiteResultCode>

edu.internet2.middleware.grouper.ws.coresoap.WsGroupSaveLiteResult.WsGroupSaveLiteResultCode

All Implemented Interfaces:

WsResultCode, java.io.Serializable, java.lang.Comparable<WsGroupSaveLiteResult.WsGroupSaveLiteResultCode>

Enclosing class:

WsGroupSaveLiteResult

public static enum WsGroupSaveLiteResult.WsGroupSaveLiteResultCode
extends java.lang.Enum<WsGroupSaveLiteResult.WsGroupSaveLiteResultCode>
implements WsResultCode

result code of a request

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCEPTION either overall exception, or one or more groups had exceptions (lite http status code 500) (success: F)
GROUP_ALREADY_EXISTS problem, group already exists (lite http status code 500) (success: F)
GROUP_NOT_FOUND the group was not found (lite http status code 404) (success: F)
INSUFFICIENT_PRIVILEGES user not allowed (lite http status code 403) (success: F)
INVALID_QUERY invalid query (e.g.
STEM_NOT_FOUND the stem was not found (lite http status code 404) (success: F)
SUCCESS_INSERTED didnt find the groups, inserted them (lite http status code 201) (success: T)
SUCCESS_NO_CHANGES_NEEDED found the groups, saved them (lite http status code 201) (success: T)
SUCCESS_UPDATED found the groups, saved them (lite http status code 201) (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
java.lang.String	nameForVersion(GrouperVersion clientVersion) get the name label for a certain version of client
static WsGroupSaveLiteResult.WsGroupSaveLiteResultCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WsGroupSaveLiteResult.WsGroupSaveLiteResultCode[]	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_INSERTED

public static final WsGroupSaveLiteResult.WsGroupSaveLiteResultCode SUCCESS_INSERTED

didnt find the groups, inserted them (lite http status code 201) (success: T)

SUCCESS_UPDATED

public static final WsGroupSaveLiteResult.WsGroupSaveLiteResultCode SUCCESS_UPDATED

found the groups, saved them (lite http status code 201) (success: T)

SUCCESS_NO_CHANGES_NEEDED

public static final WsGroupSaveLiteResult.WsGroupSaveLiteResultCode SUCCESS_NO_CHANGES_NEEDED

found the groups, saved them (lite http status code 201) (success: T)

EXCEPTION

public static final WsGroupSaveLiteResult.WsGroupSaveLiteResultCode EXCEPTION

either overall exception, or one or more groups had exceptions (lite http status code 500) (success: F)

GROUP_ALREADY_EXISTS

public static final WsGroupSaveLiteResult.WsGroupSaveLiteResultCode GROUP_ALREADY_EXISTS

problem, group already exists (lite http status code 500) (success: F)

INVALID_QUERY

public static final WsGroupSaveLiteResult.WsGroupSaveLiteResultCode INVALID_QUERY

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

GROUP_NOT_FOUND

public static final WsGroupSaveLiteResult.WsGroupSaveLiteResultCode GROUP_NOT_FOUND

the group was not found (lite http status code 404) (success: F)

INSUFFICIENT_PRIVILEGES

public static final WsGroupSaveLiteResult.WsGroupSaveLiteResultCode INSUFFICIENT_PRIVILEGES

user not allowed (lite http status code 403) (success: F)

STEM_NOT_FOUND

public static final WsGroupSaveLiteResult.WsGroupSaveLiteResultCode STEM_NOT_FOUND

the stem was not found (lite http status code 404) (success: F)

Method Detail

values

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

Returns:

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

valueOf

public static WsGroupSaveLiteResult.WsGroupSaveLiteResultCode 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()