edu.internet2.middleware.grouper.ws.soap
Enum WsStemSaveLiteResult.WsStemSaveLiteResultCode

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

public static enum WsStemSaveLiteResult.WsStemSaveLiteResultCode
extends Enum<WsStemSaveLiteResult.WsStemSaveLiteResultCode>
implements WsResultCode

result code of a request


Enum Constant Summary
EXCEPTION
          either overall exception, or one or more stems had exceptions (lite http status code 500) (success: F)
INSUFFICIENT_PRIVILEGES
          user not allowed (lite http status code 403) (success: F)
INVALID_QUERY
          invalid query (e.g.
PROBLEM_SAVING_STEMS
          problem deleting existing stems (lite http status code 500) (success: F)
STEM_NOT_FOUND
          the save was not found (lite http status code 404) (success: F)
SUCCESS_INSERTED
          inserted a new stem (lite http status code 201) (success: T)
SUCCESS_NO_CHANGES_NEEDED
          found the stem, no changes needed (lite http status code 201) (success: T)
SUCCESS_UPDATED
          found the stem, updated it (lite http status code 201) (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
 String nameForVersion(GrouperVersion clientVersion)
          get the name label for a certain version of client
static WsStemSaveLiteResult.WsStemSaveLiteResultCode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static WsStemSaveLiteResult.WsStemSaveLiteResultCode[] 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_INSERTED

public static final WsStemSaveLiteResult.WsStemSaveLiteResultCode SUCCESS_INSERTED
inserted a new stem (lite http status code 201) (success: T)


SUCCESS_UPDATED

public static final WsStemSaveLiteResult.WsStemSaveLiteResultCode SUCCESS_UPDATED
found the stem, updated it (lite http status code 201) (success: T)


SUCCESS_NO_CHANGES_NEEDED

public static final WsStemSaveLiteResult.WsStemSaveLiteResultCode SUCCESS_NO_CHANGES_NEEDED
found the stem, no changes needed (lite http status code 201) (success: T)


EXCEPTION

public static final WsStemSaveLiteResult.WsStemSaveLiteResultCode EXCEPTION
either overall exception, or one or more stems had exceptions (lite http status code 500) (success: F)


PROBLEM_SAVING_STEMS

public static final WsStemSaveLiteResult.WsStemSaveLiteResultCode PROBLEM_SAVING_STEMS
problem deleting existing stems (lite http status code 500) (success: F)


INVALID_QUERY

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


INSUFFICIENT_PRIVILEGES

public static final WsStemSaveLiteResult.WsStemSaveLiteResultCode INSUFFICIENT_PRIVILEGES
user not allowed (lite http status code 403) (success: F)


STEM_NOT_FOUND

public static final WsStemSaveLiteResult.WsStemSaveLiteResultCode STEM_NOT_FOUND
the save was not found (lite http status code 404) (success: F)

Method Detail

values

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

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

valueOf

public static WsStemSaveLiteResult.WsStemSaveLiteResultCode 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