org.csapi.jr.se.fw
Class InterfaceFault

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

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

Defines the cause of the interface fault detected.

See Also:
Serialized Form

Field Summary
static int _INTERFACE_FAULT_GATEWAY_FAILURE
          A fault in the gateway API software or hardware has been detected
static int _INTERFACE_FAULT_LOCAL_FAILURE
          A fault in the local API software or hardware has been detected
static int _INTERFACE_FAULT_PROTOCOL_ERROR
          An error in the protocol used on the client-gateway link has been detected
static int _INTERFACE_FAULT_UNDEFINED
          Undefined
static org.csapi.jr.se.fw.InterfaceFault INTERFACE_FAULT_GATEWAY_FAILURE
          A fault in the gateway API software or hardware has been detected
static org.csapi.jr.se.fw.InterfaceFault INTERFACE_FAULT_LOCAL_FAILURE
          A fault in the local API software or hardware has been detected
static org.csapi.jr.se.fw.InterfaceFault INTERFACE_FAULT_PROTOCOL_ERROR
          An error in the protocol used on the client-gateway link has been detected
static org.csapi.jr.se.fw.InterfaceFault INTERFACE_FAULT_UNDEFINED
          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.InterfaceFault getObject(int value)
          Accepts values in the range of 0 to 3
 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

_INTERFACE_FAULT_UNDEFINED

public static final int _INTERFACE_FAULT_UNDEFINED
Undefined

See Also:
Constant Field Values

INTERFACE_FAULT_UNDEFINED

public static final org.csapi.jr.se.fw.InterfaceFault INTERFACE_FAULT_UNDEFINED
Undefined


_INTERFACE_FAULT_LOCAL_FAILURE

public static final int _INTERFACE_FAULT_LOCAL_FAILURE
A fault in the local API software or hardware has been detected

See Also:
Constant Field Values

INTERFACE_FAULT_LOCAL_FAILURE

public static final org.csapi.jr.se.fw.InterfaceFault INTERFACE_FAULT_LOCAL_FAILURE
A fault in the local API software or hardware has been detected


_INTERFACE_FAULT_GATEWAY_FAILURE

public static final int _INTERFACE_FAULT_GATEWAY_FAILURE
A fault in the gateway API software or hardware has been detected

See Also:
Constant Field Values

INTERFACE_FAULT_GATEWAY_FAILURE

public static final org.csapi.jr.se.fw.InterfaceFault INTERFACE_FAULT_GATEWAY_FAILURE
A fault in the gateway API software or hardware has been detected


_INTERFACE_FAULT_PROTOCOL_ERROR

public static final int _INTERFACE_FAULT_PROTOCOL_ERROR
An error in the protocol used on the client-gateway link has been detected

See Also:
Constant Field Values

INTERFACE_FAULT_PROTOCOL_ERROR

public static final org.csapi.jr.se.fw.InterfaceFault INTERFACE_FAULT_PROTOCOL_ERROR
An error in the protocol used on the client-gateway link has been detected

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 InterfaceFault object

getObject

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

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