Enum Class WsGetGroupsResult.WsGetGroupsResultCode
java.lang.Object
java.lang.Enum<WsGetGroupsResult.WsGetGroupsResultCode>
edu.internet2.middleware.grouper.ws.coresoap.WsGetGroupsResult.WsGetGroupsResultCode
- All Implemented Interfaces:
WsResultCode
,Serializable
,Comparable<WsGetGroupsResult.WsGetGroupsResultCode>
,Constable
- Enclosing class:
- WsGetGroupsResult
public static enum WsGetGroupsResult.WsGetGroupsResultCode
extends Enum<WsGetGroupsResult.WsGetGroupsResultCode>
implements WsResultCode
result code of a request
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionproblem (lite http status code 500) (success: F)problem (lite http status code 400) (success: F)couldnt find the member to query (lite http status code 404) (success: F)problem querying the subject, was duplicate (lite http status code 409) (success: F)couldnt find the subject to query (lite http status code 404) (success: F)found the subject (lite http status code 200) (success: T) -
Method Summary
Modifier and TypeMethodDescriptionif there is one result, convert to the results codeint
get the http status code associated with this status code, e.g.boolean
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 subject (lite http status code 200) (success: T) -
EXCEPTION
problem (lite http status code 500) (success: F) -
INVALID_QUERY
problem (lite http status code 400) (success: F) -
MEMBER_NOT_FOUND
couldnt find the member to query (lite http status code 404) (success: F) -
SUBJECT_NOT_FOUND
couldnt find the subject to query (lite http status code 404) (success: F) -
SUBJECT_DUPLICATE
problem querying the subject, was duplicate (lite http status code 409) (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:
-
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 interfaceWsResultCode
- Returns:
- the status code e.g. 200
- See Also:
-
isSuccess
public boolean isSuccess()if this is a successful result- Specified by:
isSuccess
in interfaceWsResultCode
- Returns:
- true if success
-
convertToLiteCode
if there is one result, convert to the results code- Returns:
- result code
-