edu.internet2.middleware.grouper.ws.coresoap

Enum WsStemSaveResult.WsStemSaveResultCode

java.lang.Object

java.lang.Enum<WsStemSaveResult.WsStemSaveResultCode>

edu.internet2.middleware.grouper.ws.coresoap.WsStemSaveResult.WsStemSaveResultCode

All Implemented Interfaces:

Serializable, Comparable<WsStemSaveResult.WsStemSaveResultCode>

Enclosing class:

WsStemSaveResult

public static enum WsStemSaveResult.WsStemSaveResultCode
extends Enum<WsStemSaveResult.WsStemSaveResultCode>

result code of a request

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCEPTION problem with saving
INSUFFICIENT_PRIVILEGES user not allowed
INVALID_QUERY invalid query, can only happen if lite query
STEM_NOT_FOUND the save was not found
SUCCESS_INSERTED successful addition
SUCCESS_NO_CHANGES_NEEDED successful addition
SUCCESS_UPDATED successful addition
TRANSACTION_ROLLED_BACK was a success but rolled back

Method Summary

Modifier and Type	Method and Description
abstract WsStemSaveLiteResult.WsStemSaveLiteResultCode	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 WsStemSaveResult.WsStemSaveResultCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static WsStemSaveResult.WsStemSaveResultCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS_INSERTED

public static final WsStemSaveResult.WsStemSaveResultCode SUCCESS_INSERTED

successful addition

SUCCESS_UPDATED

public static final WsStemSaveResult.WsStemSaveResultCode SUCCESS_UPDATED

successful addition

SUCCESS_NO_CHANGES_NEEDED

public static final WsStemSaveResult.WsStemSaveResultCode SUCCESS_NO_CHANGES_NEEDED

successful addition

INVALID_QUERY

public static final WsStemSaveResult.WsStemSaveResultCode INVALID_QUERY

invalid query, can only happen if lite query

STEM_NOT_FOUND

public static final WsStemSaveResult.WsStemSaveResultCode STEM_NOT_FOUND

the save was not found

EXCEPTION

public static final WsStemSaveResult.WsStemSaveResultCode EXCEPTION

problem with saving

TRANSACTION_ROLLED_BACK

public static final WsStemSaveResult.WsStemSaveResultCode TRANSACTION_ROLLED_BACK

was a success but rolled back

INSUFFICIENT_PRIVILEGES

public static final WsStemSaveResult.WsStemSaveResultCode INSUFFICIENT_PRIVILEGES

user not allowed

Method Detail

values

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

Returns:

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

valueOf

public static WsStemSaveResult.WsStemSaveResultCode valueOf(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:

IllegalArgumentException - if this enum type 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

Parameters:

clientVersion -

Returns:

isSuccess

public boolean isSuccess()

if this is a successful result

Returns:

true if success

convertToLiteCode

public abstract WsStemSaveLiteResult.WsStemSaveLiteResultCode convertToLiteCode()

if there is one result, convert to the results code

Returns:

result code