Enum Class WsGshTemplateExecResult.WsGshTemplateExecResultCode
java.lang.Object
java.lang.Enum<WsGshTemplateExecResult.WsGshTemplateExecResultCode>
edu.internet2.middleware.grouper.ws.coresoap.WsGshTemplateExecResult.WsGshTemplateExecResultCode
- All Implemented Interfaces:
WsResultCode
,Serializable
,Comparable<WsGshTemplateExecResult.WsGshTemplateExecResultCode>
,Constable
- Enclosing class:
- WsGshTemplateExecResult
public static enum WsGshTemplateExecResult.WsGshTemplateExecResultCode
extends Enum<WsGshTemplateExecResult.WsGshTemplateExecResultCode>
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 ConstantDescriptionexception was thrown while running gsh template (http status code 500) (success: F)exception was thrown while running gsh template (http status code 500) (success: F)invalid input (e.g.executed the gsh template successfully (http status code 200) (success: T) -
Method Summary
Modifier and TypeMethodDescriptionint
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
executed the gsh template successfully (http status code 200) (success: T) -
ERROR
exception was thrown while running gsh template (http status code 500) (success: F) -
EXCEPTION
exception was thrown while running gsh template (http status code 500) (success: F) -
INVALID
invalid input (e.g. if everything blank) (http 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()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:
-