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

Enum Class WsSubjectLookup.SubjectFindResult

java.lang.Object

java.lang.Enum<WsSubjectLookup.SubjectFindResult>

edu.internet2.middleware.grouper.ws.coresoap.WsSubjectLookup.SubjectFindResult

All Implemented Interfaces:

Serializable, Comparable<WsSubjectLookup.SubjectFindResult>, Constable

Enclosing class:

WsSubjectLookup

public static enum WsSubjectLookup.SubjectFindResult
extends Enum<WsSubjectLookup.SubjectFindResult>

result of a subject find

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
INVALID_QUERY	invalid query (e.g.
SOURCE_UNAVAILABLE	when the source if not available
SUBJECT_DUPLICATE	found multiple results
SUBJECT_NOT_FOUND	cant find the subject
SUCCESS	found the subject
SUCCESS_CREATED	if the subject was not found, but created e.g.

Method Summary

Modifier and Type	Method	Description
abstract WsHasMemberResult.WsHasMemberResultCode	convertToHasMemberResultCode()	convert to has member result
boolean	isSuccess()	if this is a successful result
static WsSubjectLookup.SubjectFindResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WsSubjectLookup.SubjectFindResult[]	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

public static final WsSubjectLookup.SubjectFindResult SUCCESS

found the subject

SUCCESS_CREATED

public static final WsSubjectLookup.SubjectFindResult SUCCESS_CREATED

if the subject was not found, but created e.g. as an external subject

SUBJECT_DUPLICATE

public static final WsSubjectLookup.SubjectFindResult SUBJECT_DUPLICATE

found multiple results

SUBJECT_NOT_FOUND

public static final WsSubjectLookup.SubjectFindResult SUBJECT_NOT_FOUND

cant find the subject

INVALID_QUERY

public static final WsSubjectLookup.SubjectFindResult INVALID_QUERY

invalid query (e.g. if everything blank)

SOURCE_UNAVAILABLE

public static final WsSubjectLookup.SubjectFindResult SOURCE_UNAVAILABLE

when the source if not available

Method Details

values

public static WsSubjectLookup.SubjectFindResult[] 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 WsSubjectLookup.SubjectFindResult 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

convertToHasMemberResultCode

public abstract WsHasMemberResult.WsHasMemberResultCode convertToHasMemberResultCode()

convert to has member result

Returns:

the has member code

isSuccess

public boolean isSuccess()

if this is a successful result

Returns:

true if success