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

Enum Class WsGroupSaveResult.WsGroupSaveResultCode

java.lang.Object

java.lang.Enum<WsGroupSaveResult.WsGroupSaveResultCode>

edu.internet2.middleware.grouper.ws.coresoap.WsGroupSaveResult.WsGroupSaveResultCode

All Implemented Interfaces:

Serializable, Comparable<WsGroupSaveResult.WsGroupSaveResultCode>, Constable

Enclosing class:

WsGroupSaveResult

public static enum WsGroupSaveResult.WsGroupSaveResultCode
extends Enum<WsGroupSaveResult.WsGroupSaveResultCode>

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	problem with saving (success: F)
GROUP_ALREADY_EXISTS	problem with saving (success: F)
GROUP_NOT_FOUND	the group was not found (success: F)
INSUFFICIENT_PRIVILEGES	user not allowed (success: F)
INVALID_QUERY	invalid query, can only happen if Lite query (success: F)
STEM_NOT_FOUND	the stem was not found (success: F)
SUCCESS_INSERTED	successful addition (success: T)
SUCCESS_NO_CHANGES_NEEDED	successful addition (success: T)
SUCCESS_UPDATED	successful addition (success: T)
TRANSACTION_ROLLED_BACK	was a success but rolled back

Method Summary

Modifier and Type	Method	Description
abstract WsGroupSaveLiteResult.WsGroupSaveLiteResultCode	convertToLiteCode()	if there is one result, convert to the results code
boolean	isSuccess()	if this is a successful result
String	nameForVersion(GrouperVersion clientVersion)	get the name label for a certain version of client
static WsGroupSaveResult.WsGroupSaveResultCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WsGroupSaveResult.WsGroupSaveResultCode[]	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

Enum Constant Details

SUCCESS_INSERTED

public static final WsGroupSaveResult.WsGroupSaveResultCode SUCCESS_INSERTED

successful addition (success: T)

SUCCESS_UPDATED

public static final WsGroupSaveResult.WsGroupSaveResultCode SUCCESS_UPDATED

successful addition (success: T)

SUCCESS_NO_CHANGES_NEEDED

public static final WsGroupSaveResult.WsGroupSaveResultCode SUCCESS_NO_CHANGES_NEEDED

successful addition (success: T)

INVALID_QUERY

public static final WsGroupSaveResult.WsGroupSaveResultCode INVALID_QUERY

invalid query, can only happen if Lite query (success: F)

GROUP_NOT_FOUND

public static final WsGroupSaveResult.WsGroupSaveResultCode GROUP_NOT_FOUND

the group was not found (success: F)

STEM_NOT_FOUND

public static final WsGroupSaveResult.WsGroupSaveResultCode STEM_NOT_FOUND

the stem was not found (success: F)

EXCEPTION

public static final WsGroupSaveResult.WsGroupSaveResultCode EXCEPTION

problem with saving (success: F)

GROUP_ALREADY_EXISTS

public static final WsGroupSaveResult.WsGroupSaveResultCode GROUP_ALREADY_EXISTS

problem with saving (success: F)

INSUFFICIENT_PRIVILEGES

public static final WsGroupSaveResult.WsGroupSaveResultCode INSUFFICIENT_PRIVILEGES

user not allowed (success: F)

TRANSACTION_ROLLED_BACK

public static final WsGroupSaveResult.WsGroupSaveResultCode TRANSACTION_ROLLED_BACK

was a success but rolled back

Method Details

values

public static WsGroupSaveResult.WsGroupSaveResultCode[] 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 WsGroupSaveResult.WsGroupSaveResultCode 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

isSuccess

public boolean isSuccess()

if this is a successful result

Returns:

true if success

nameForVersion

public String nameForVersion(GrouperVersion clientVersion)

get the name label for a certain version of client

Parameters:

clientVersion -

Returns:

convertToLiteCode

public abstract WsGroupSaveLiteResult.WsGroupSaveLiteResultCode convertToLiteCode()

if there is one result, convert to the results code

Returns:

result code