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

Enum Class WsAddMemberResult.WsAddMemberResultCode

java.lang.Object

java.lang.Enum<WsAddMemberResult.WsAddMemberResultCode>

edu.internet2.middleware.grouper.ws.coresoap.WsAddMemberResult.WsAddMemberResultCode

All Implemented Interfaces:

Serializable, Comparable<WsAddMemberResult.WsAddMemberResultCode>, Constable

Enclosing class:

WsAddMemberResult

public static enum WsAddMemberResult.WsAddMemberResultCode
extends Enum<WsAddMemberResult.WsAddMemberResultCode>

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 addition (success: F)
GROUP_NOT_FOUND	cant find group (success: F)
INSUFFICIENT_PRIVILEGES	user not allowed (success: F)
INVALID_QUERY	invalid request (success: F)
SUBJECT_DUPLICATE	subject duplicate found (success: F)
SUBJECT_NOT_FOUND	the subject was not found (success: F)
SUCCESS	successful addition (success: T)
SUCCESS_ALREADY_EXISTED	successful addition if already a member (success: T)
SUCCESS_CREATED	successful addition (success: T)
TRANSACTION_ROLLED_BACK	if one item failed in the transaction, then roll back (success: F)

Method Summary

Modifier and Type	Method	Description
abstract WsAddMemberLiteResult.WsAddMemberLiteResultCode	convertToLiteCode()	if there is one result, convert to the results code
boolean	isSuccess()	if this is a successful result
static WsAddMemberResult.WsAddMemberResultCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WsAddMemberResult.WsAddMemberResultCode[]	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

INVALID_QUERY

public static final WsAddMemberResult.WsAddMemberResultCode INVALID_QUERY

invalid request (success: F)

GROUP_NOT_FOUND

public static final WsAddMemberResult.WsAddMemberResultCode GROUP_NOT_FOUND

cant find group (success: F)

SUCCESS

public static final WsAddMemberResult.WsAddMemberResultCode SUCCESS

successful addition (success: T)

SUCCESS_CREATED

public static final WsAddMemberResult.WsAddMemberResultCode SUCCESS_CREATED

successful addition (success: T)

SUCCESS_ALREADY_EXISTED

public static final WsAddMemberResult.WsAddMemberResultCode SUCCESS_ALREADY_EXISTED

successful addition if already a member (success: T)

SUBJECT_NOT_FOUND

public static final WsAddMemberResult.WsAddMemberResultCode SUBJECT_NOT_FOUND

the subject was not found (success: F)

EXCEPTION

public static final WsAddMemberResult.WsAddMemberResultCode EXCEPTION

problem with addition (success: F)

INSUFFICIENT_PRIVILEGES

public static final WsAddMemberResult.WsAddMemberResultCode INSUFFICIENT_PRIVILEGES

user not allowed (success: F)

TRANSACTION_ROLLED_BACK

public static final WsAddMemberResult.WsAddMemberResultCode TRANSACTION_ROLLED_BACK

if one item failed in the transaction, then roll back (success: F)

SUBJECT_DUPLICATE

public static final WsAddMemberResult.WsAddMemberResultCode SUBJECT_DUPLICATE

subject duplicate found (success: F)

Method Details

values

public static WsAddMemberResult.WsAddMemberResultCode[] 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 WsAddMemberResult.WsAddMemberResultCode 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

convertToLiteCode

public abstract WsAddMemberLiteResult.WsAddMemberLiteResultCode convertToLiteCode()

if there is one result, convert to the results code

Returns:

result code