edu.internet2.middleware.grouper.ws.soap
Enum WsStemLookup.StemFindResult

java.lang.Object
  extended by java.lang.Enum<WsStemLookup.StemFindResult>
      extended by edu.internet2.middleware.grouper.ws.soap.WsStemLookup.StemFindResult
All Implemented Interfaces:
Serializable, Comparable<WsStemLookup.StemFindResult>
Enclosing class:
WsStemLookup

public static enum WsStemLookup.StemFindResult
extends Enum<WsStemLookup.StemFindResult>

result of stem find


Enum Constant Summary
INVALID_QUERY
          incvalid query (e.g.
STEM_NOT_FOUND
          cant find the subject
SUCCESS
          found the stem
 
Method Summary
abstract  WsStemDeleteResult.WsStemDeleteResultCode convertToDeleteCode()
          convert this code to a delete code
static WsStemDeleteResult.WsStemDeleteResultCode convertToDeleteCodeStatic(WsStemLookup.StemFindResult stemFindResult)
          null safe equivalent to convertToDeleteCode
 boolean isSuccess()
          if this is a successful result
static WsStemLookup.StemFindResult valueOf(String name)
          Returns the enum constant of this type with the specified name.
static WsStemLookup.StemFindResult[] 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 WsStemLookup.StemFindResult SUCCESS
found the stem


STEM_NOT_FOUND

public static final WsStemLookup.StemFindResult STEM_NOT_FOUND
cant find the subject


INVALID_QUERY

public static final WsStemLookup.StemFindResult INVALID_QUERY
incvalid query (e.g. if everything blank)

Method Detail

values

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

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

valueOf

public static WsStemLookup.StemFindResult 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

isSuccess

public boolean isSuccess()
if this is a successful result

Returns:
true if success

convertToDeleteCode

public abstract WsStemDeleteResult.WsStemDeleteResultCode convertToDeleteCode()
convert this code to a delete code

Returns:
the code

convertToDeleteCodeStatic

public static WsStemDeleteResult.WsStemDeleteResultCode convertToDeleteCodeStatic(WsStemLookup.StemFindResult stemFindResult)
null safe equivalent to convertToDeleteCode

Parameters:
stemFindResult - to convert
Returns:
the code