edu.internet2.middleware.grouper.ws.coresoap

Enum WsSubjectLookup.SubjectFindResult

java.lang.Object

java.lang.Enum<WsSubjectLookup.SubjectFindResult>

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WsSubjectLookup.SubjectFindResult>

Enclosing class:

WsSubjectLookup

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

result of a subject find

Enum Constant Summary

Enum Constants

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

Enum Constant Detail

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 Detail

values

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

Returns:

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

valueOf

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

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