org.csapi.jr.se.fw
Class APIUnavailReason

java.lang.Object
  |
  +--org.csapi.jr.se.fw.APIUnavailReason
All Implemented Interfaces:
java.io.Serializable

public final class APIUnavailReason
extends java.lang.Object
implements java.io.Serializable

The reason why the API is unavailable. Undefined. The local API software or hardware has failed. The gateway API software or hardware has failed. The framework is fully overloaded. The framework has closed itself. The protocol used on the client - gateway link has failed.

See Also:
Serialized Form

Field Summary
static int _API_UNAVAILABLE_CLOSED
           
static int _API_UNAVAILABLE_GATEWAY_FAILURE
           
static int _API_UNAVAILABLE_LOCAL_FAILURE
           
static int _API_UNAVAILABLE_OVERLOADED
           
static int _API_UNAVAILABLE_PROTOCOL_FAILURE
           
static int _API_UNAVAILABLE_UNDEFINED
           
static org.csapi.jr.se.fw.APIUnavailReason API_UNAVAILABLE_CLOSED
           
static org.csapi.jr.se.fw.APIUnavailReason API_UNAVAILABLE_GATEWAY_FAILURE
           
static org.csapi.jr.se.fw.APIUnavailReason API_UNAVAILABLE_LOCAL_FAILURE
           
static org.csapi.jr.se.fw.APIUnavailReason API_UNAVAILABLE_OVERLOADED
           
static org.csapi.jr.se.fw.APIUnavailReason API_UNAVAILABLE_PROTOCOL_FAILURE
           
static org.csapi.jr.se.fw.APIUnavailReason API_UNAVAILABLE_UNDEFINED
           
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is 'equal to' this one.
static org.csapi.jr.se.fw.APIUnavailReason getObject(int value)
          Accepts values in the range of 0 to 5
 int getValue()
          Number representing enum type
 java.lang.String getValueText()
          getValueText method, overrides the getValueText() method in class java.lang.Object
 int hashCode()
          Returns a hashcode value for the object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_API_UNAVAILABLE_UNDEFINED

public static final int _API_UNAVAILABLE_UNDEFINED
See Also:
Constant Field Values

API_UNAVAILABLE_UNDEFINED

public static final org.csapi.jr.se.fw.APIUnavailReason API_UNAVAILABLE_UNDEFINED

_API_UNAVAILABLE_LOCAL_FAILURE

public static final int _API_UNAVAILABLE_LOCAL_FAILURE
See Also:
Constant Field Values

API_UNAVAILABLE_LOCAL_FAILURE

public static final org.csapi.jr.se.fw.APIUnavailReason API_UNAVAILABLE_LOCAL_FAILURE

_API_UNAVAILABLE_GATEWAY_FAILURE

public static final int _API_UNAVAILABLE_GATEWAY_FAILURE
See Also:
Constant Field Values

API_UNAVAILABLE_GATEWAY_FAILURE

public static final org.csapi.jr.se.fw.APIUnavailReason API_UNAVAILABLE_GATEWAY_FAILURE

_API_UNAVAILABLE_OVERLOADED

public static final int _API_UNAVAILABLE_OVERLOADED
See Also:
Constant Field Values

API_UNAVAILABLE_OVERLOADED

public static final org.csapi.jr.se.fw.APIUnavailReason API_UNAVAILABLE_OVERLOADED

_API_UNAVAILABLE_CLOSED

public static final int _API_UNAVAILABLE_CLOSED
See Also:
Constant Field Values

API_UNAVAILABLE_CLOSED

public static final org.csapi.jr.se.fw.APIUnavailReason API_UNAVAILABLE_CLOSED

_API_UNAVAILABLE_PROTOCOL_FAILURE

public static final int _API_UNAVAILABLE_PROTOCOL_FAILURE
See Also:
Constant Field Values

API_UNAVAILABLE_PROTOCOL_FAILURE

public static final org.csapi.jr.se.fw.APIUnavailReason API_UNAVAILABLE_PROTOCOL_FAILURE
Method Detail

getValue

public int getValue()
Number representing enum type

Returns:
int number representing type of object, this is defined within the class

getValueText

public java.lang.String getValueText()
getValueText method, overrides the getValueText() method in class java.lang.Object

Returns:
String The stringified version of the APIUnavailReason object

getObject

public static org.csapi.jr.se.fw.APIUnavailReason getObject(int value)
                                                     throws InvalidEnumValueException
Accepts values in the range of 0 to 5

Parameters:
value - number representing type of object, this is defined within the class
Throws:
InvalidEnumValueException - thrown if invalid value is passed into method

equals

public boolean equals(java.lang.Object o)
Indicates whether some other object is 'equal to' this one.

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Returns a hashcode value for the object.

Overrides:
hashCode in class java.lang.Object