edu.internet2.middleware.grouper.ws.coresoap
Enum WsMessageAcknowledgeResults.WsMessageAcknowledgeResultsCode

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

public static enum WsMessageAcknowledgeResults.WsMessageAcknowledgeResultsCode
extends java.lang.Enum<WsMessageAcknowledgeResults.WsMessageAcknowledgeResultsCode>
implements WsResultCode

result code of a request


Enum Constant Summary
EXCEPTION
          problems with operation (lite http status code 500) (success: F)
INVALID_QUERY
          invalid query (e.g.
SUCCESS
          messages acknowledged successfully (lite http status code 200) (success: T)
 
Method Summary
 int getHttpStatusCode()
          get the http status code associated with this status code, e.g.
 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 WsMessageAcknowledgeResults.WsMessageAcknowledgeResultsCode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static WsMessageAcknowledgeResults.WsMessageAcknowledgeResultsCode[] 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 WsMessageAcknowledgeResults.WsMessageAcknowledgeResultsCode SUCCESS
messages acknowledged successfully (lite http status code 200) (success: T)


EXCEPTION

public static final WsMessageAcknowledgeResults.WsMessageAcknowledgeResultsCode EXCEPTION
problems with operation (lite http status code 500) (success: F)


INVALID_QUERY

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

Method Detail

values

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

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

valueOf

public static WsMessageAcknowledgeResults.WsMessageAcknowledgeResultsCode 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:
name

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