Enum Class WsGetMembersLiteResult.WsGetMembersLiteResultCode
java.lang.Object
java.lang.Enum<WsGetMembersLiteResult.WsGetMembersLiteResultCode>
edu.internet2.middleware.grouper.ws.coresoap.WsGetMembersLiteResult.WsGetMembersLiteResultCode
- All Implemented Interfaces:
WsResultCode
,Serializable
,Comparable<WsGetMembersLiteResult.WsGetMembersLiteResultCode>
,Constable
- Enclosing class:
- WsGetMembersLiteResult
public static enum WsGetMembersLiteResult.WsGetMembersLiteResultCode
extends Enum<WsGetMembersLiteResult.WsGetMembersLiteResultCode>
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)
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionsomething bad happened (lite status code 500) (success: F)cant find group (lite status code 404) (success: F)if there is one result, convert to the results code (lite status code 400) (success: F)invalid query (e.g.something bad happened with some of the member retrieval (lite status code 500) (success: F)found the members (lite status code 200) (success: T) -
Method Summary
Modifier and TypeMethodDescriptionint
get the http result code for this status codeboolean
if this is a successful resultnameForVersion
(GrouperVersion clientVersion) get the name label for a certain version of clientReturns the enum constant of this class with the specified name.values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods inherited from interface edu.internet2.middleware.grouper.ws.WsResultCode
name
-
Enum Constant Details
-
SUCCESS
found the members (lite status code 200) (success: T) -
EXCEPTION
something bad happened (lite status code 500) (success: F) -
PROBLEM_GETTING_MEMBERS
something bad happened with some of the member retrieval (lite status code 500) (success: F) -
INVALID_QUERY
invalid query (e.g. if everything blank) (lite status code 400) (success: F) -
GROUP_NOT_FOUND
cant find group (lite status code 404) (success: F) -
GROUP_UUID_DOESNT_MATCH_NAME
if there is one result, convert to the results code (lite status code 400) (success: F)
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
nameForVersion
get the name label for a certain version of client- Specified by:
nameForVersion
in interfaceWsResultCode
- Parameters:
clientVersion
-- Returns:
-
isSuccess
public boolean isSuccess()if this is a successful result- Specified by:
isSuccess
in interfaceWsResultCode
- Returns:
- true if success
-
getHttpStatusCode
public int getHttpStatusCode()get the http result code for this status code- Specified by:
getHttpStatusCode
in interfaceWsResultCode
- Returns:
- the status code
-