edu.internet2.middleware.grouper.ws.soap
Enum WsFindGroupsResults.WsFindGroupsResultsCode

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

public static enum WsFindGroupsResults.WsFindGroupsResultsCode
extends Enum<WsFindGroupsResults.WsFindGroupsResultsCode>
implements WsResultCode

result code of a request


Enum Constant Summary
EXCEPTION
          found the subject (lite http status code 500) (success: F)
INVALID_QUERY
          invalid query (e.g.
STEM_NOT_FOUND
          cant find the stem in a stem search (lite http status code 404) (success: F)
SUCCESS
          found the subject (lite http status code 200) (success: F)
 
Method Summary
 int getHttpStatusCode()
          get the http status code associated with this status code, e.g.
 boolean isSuccess()
          if this is a successful result
 String nameForVersion(GrouperVersion clientVersion)
          get the name label for a certain version of client
static WsFindGroupsResults.WsFindGroupsResultsCode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static WsFindGroupsResults.WsFindGroupsResultsCode[] 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
 
Methods inherited from interface edu.internet2.middleware.grouper.ws.WsResultCode
name
 

Enum Constant Detail

SUCCESS

public static final WsFindGroupsResults.WsFindGroupsResultsCode SUCCESS
found the subject (lite http status code 200) (success: F)


EXCEPTION

public static final WsFindGroupsResults.WsFindGroupsResultsCode EXCEPTION
found the subject (lite http status code 500) (success: F)


INVALID_QUERY

public static final WsFindGroupsResults.WsFindGroupsResultsCode INVALID_QUERY
invalid query (e.g. if everything blank) (lite http status code 400) (success: F)


STEM_NOT_FOUND

public static final WsFindGroupsResults.WsFindGroupsResultsCode STEM_NOT_FOUND
cant find the stem in a stem search (lite http status code 404) (success: F)

Method Detail

values

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

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

valueOf

public static WsFindGroupsResults.WsFindGroupsResultsCode 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

Specified by:
nameForVersion in interface WsResultCode
Parameters:
clientVersion -
Returns:

getHttpStatusCode

public int getHttpStatusCode()
Description copied from interface: WsResultCode
get the http status code associated with this status code, e.g. 200

Specified by:
getHttpStatusCode in interface WsResultCode
Returns:
the status code e.g. 200
See Also:
WsResultCode.getHttpStatusCode()

isSuccess

public boolean isSuccess()
if this is a successful result

Specified by:
isSuccess in interface WsResultCode
Returns:
true if success