edu.internet2.middleware.grouper.ws.coresoap
Enum WsGetMembersResults.WsGetMembersResultsCode

java.lang.Object
  extended by java.lang.Enum<WsGetMembersResults.WsGetMembersResultsCode>
      extended by edu.internet2.middleware.grouper.ws.coresoap.WsGetMembersResults.WsGetMembersResultsCode
All Implemented Interfaces:
WsResultCode, java.io.Serializable, java.lang.Comparable<WsGetMembersResults.WsGetMembersResultsCode>
Enclosing class:
WsGetMembersResults

public static enum WsGetMembersResults.WsGetMembersResultsCode
extends java.lang.Enum<WsGetMembersResults.WsGetMembersResultsCode>
implements WsResultCode

result code of a request. The possible result codes of WsGetMembersResultCode (with http status codes) are: SUCCESS(200), EXCEPTION(500), INVALID_QUERY(400)


Enum Constant Summary
EXCEPTION
          something bad happened (lite status code 500) (success: F)
INVALID_QUERY
          invalid query (e.g.
PROBLEM_GETTING_MEMBERS
          something bad happened with some of the member retrieval (lite status code 500) (success: F)
SUCCESS
          found the members (lite status code 200) (success: T)
 
Method Summary
 int getHttpStatusCode()
          get the http result code for this status code
 boolean isSuccess()
          if this is a successful result
 java.lang.String nameForVersion(GrouperVersion clientVersion)
          get the name label for a certain version of client
static WsGetMembersResults.WsGetMembersResultsCode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static WsGetMembersResults.WsGetMembersResultsCode[] 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 WsGetMembersResults.WsGetMembersResultsCode SUCCESS
found the members (lite status code 200) (success: T)


EXCEPTION

public static final WsGetMembersResults.WsGetMembersResultsCode EXCEPTION
something bad happened (lite status code 500) (success: F)


PROBLEM_GETTING_MEMBERS

public static final WsGetMembersResults.WsGetMembersResultsCode PROBLEM_GETTING_MEMBERS
something bad happened with some of the member retrieval (lite status code 500) (success: F)


INVALID_QUERY

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

Method Detail

values

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

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

valueOf

public static WsGetMembersResults.WsGetMembersResultsCode 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

nameForVersion

public java.lang.String nameForVersion(GrouperVersion clientVersion)
get the name label for a certain version of client

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

isSuccess

public boolean isSuccess()
if this is a successful result

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

getHttpStatusCode

public int getHttpStatusCode()
get the http result code for this status code

Specified by:
getHttpStatusCode in interface WsResultCode
Returns:
the status code