org.csapi.jr.se.ui
Class UIError

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

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

Defines the UI error codes. The call User Interaction object will be automatically de-assigned if the error P_UI_ERROR_ABANDON is reported, as a corresponding call or call leg object no longer exists.

See Also:
Serialized Form

Field Summary
static int _UI_ERROR_ABANDON
          The specified leg is disconnected before the send information completed
static int _UI_ERROR_ID_NOT_FOUND
          A legal InfoId is not known to the User Interaction service
static int _UI_ERROR_ILLEGAL_INFO
          The specified information (InfoId, InfoData, or InfoAddress) is invalid
static int _UI_ERROR_ILLEGAL_RANGE
          The values for minimum and maximum collection length are out of range
static int _UI_ERROR_IMPROPER_USER_RESPONSE
          Improper user response
static int _UI_ERROR_NO_OPERATION_ACTIVE
          There is no active User Interaction for the specified leg.
static int _UI_ERROR_NO_SPACE_AVAILABLE
          There is no more storage capacity to record the message when the recordMessageReq() operation was called
static int _UI_ERROR_RESOURCE_TIMEOUT
          The request has been accepted by the resource but it did not report a result.
static int _UI_ERROR_RESOURCE_UNAVAILABLE
          The information resources used by the User Interaction service are unavailable, for example due to an overload situation.
static int _UI_ERROR_UNDEFINED
          Undefined error
static org.csapi.jr.se.ui.UIError UI_ERROR_ABANDON
          The specified leg is disconnected before the send information completed
static org.csapi.jr.se.ui.UIError UI_ERROR_ID_NOT_FOUND
          A legal InfoId is not known to the User Interaction service
static org.csapi.jr.se.ui.UIError UI_ERROR_ILLEGAL_INFO
          The specified information (InfoId, InfoData, or InfoAddress) is invalid
static org.csapi.jr.se.ui.UIError UI_ERROR_ILLEGAL_RANGE
          The values for minimum and maximum collection length are out of range
static org.csapi.jr.se.ui.UIError UI_ERROR_IMPROPER_USER_RESPONSE
          Improper user response
static org.csapi.jr.se.ui.UIError UI_ERROR_NO_OPERATION_ACTIVE
          There is no active User Interaction for the specified leg.
static org.csapi.jr.se.ui.UIError UI_ERROR_NO_SPACE_AVAILABLE
          There is no more storage capacity to record the message when the recordMessageReq() operation was called
static org.csapi.jr.se.ui.UIError UI_ERROR_RESOURCE_TIMEOUT
          The request has been accepted by the resource but it did not report a result.
static org.csapi.jr.se.ui.UIError UI_ERROR_RESOURCE_UNAVAILABLE
          The information resources used by the User Interaction service are unavailable, for example due to an overload situation.
static org.csapi.jr.se.ui.UIError UI_ERROR_UNDEFINED
          Undefined error
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is 'equal to' this one.
static org.csapi.jr.se.ui.UIError getObject(int value)
          Accepts values in the range of 0 to 9
 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

_UI_ERROR_UNDEFINED

public static final int _UI_ERROR_UNDEFINED
Undefined error

See Also:
Constant Field Values

UI_ERROR_UNDEFINED

public static final org.csapi.jr.se.ui.UIError UI_ERROR_UNDEFINED
Undefined error


_UI_ERROR_ILLEGAL_INFO

public static final int _UI_ERROR_ILLEGAL_INFO
The specified information (InfoId, InfoData, or InfoAddress) is invalid

See Also:
Constant Field Values

UI_ERROR_ILLEGAL_INFO

public static final org.csapi.jr.se.ui.UIError UI_ERROR_ILLEGAL_INFO
The specified information (InfoId, InfoData, or InfoAddress) is invalid


_UI_ERROR_ID_NOT_FOUND

public static final int _UI_ERROR_ID_NOT_FOUND
A legal InfoId is not known to the User Interaction service

See Also:
Constant Field Values

UI_ERROR_ID_NOT_FOUND

public static final org.csapi.jr.se.ui.UIError UI_ERROR_ID_NOT_FOUND
A legal InfoId is not known to the User Interaction service


_UI_ERROR_RESOURCE_UNAVAILABLE

public static final int _UI_ERROR_RESOURCE_UNAVAILABLE
The information resources used by the User Interaction service are unavailable, for example due to an overload situation.

See Also:
Constant Field Values

UI_ERROR_RESOURCE_UNAVAILABLE

public static final org.csapi.jr.se.ui.UIError UI_ERROR_RESOURCE_UNAVAILABLE
The information resources used by the User Interaction service are unavailable, for example due to an overload situation.


_UI_ERROR_ILLEGAL_RANGE

public static final int _UI_ERROR_ILLEGAL_RANGE
The values for minimum and maximum collection length are out of range

See Also:
Constant Field Values

UI_ERROR_ILLEGAL_RANGE

public static final org.csapi.jr.se.ui.UIError UI_ERROR_ILLEGAL_RANGE
The values for minimum and maximum collection length are out of range


_UI_ERROR_IMPROPER_USER_RESPONSE

public static final int _UI_ERROR_IMPROPER_USER_RESPONSE
Improper user response

See Also:
Constant Field Values

UI_ERROR_IMPROPER_USER_RESPONSE

public static final org.csapi.jr.se.ui.UIError UI_ERROR_IMPROPER_USER_RESPONSE
Improper user response


_UI_ERROR_ABANDON

public static final int _UI_ERROR_ABANDON
The specified leg is disconnected before the send information completed

See Also:
Constant Field Values

UI_ERROR_ABANDON

public static final org.csapi.jr.se.ui.UIError UI_ERROR_ABANDON
The specified leg is disconnected before the send information completed


_UI_ERROR_NO_OPERATION_ACTIVE

public static final int _UI_ERROR_NO_OPERATION_ACTIVE
There is no active User Interaction for the specified leg. Either the application did not start any User Interaction or the User Interaction was already finished when the abortActionReq() was called.

See Also:
Constant Field Values

UI_ERROR_NO_OPERATION_ACTIVE

public static final org.csapi.jr.se.ui.UIError UI_ERROR_NO_OPERATION_ACTIVE
There is no active User Interaction for the specified leg. Either the application did not start any User Interaction or the User Interaction was already finished when the abortActionReq() was called.


_UI_ERROR_NO_SPACE_AVAILABLE

public static final int _UI_ERROR_NO_SPACE_AVAILABLE
There is no more storage capacity to record the message when the recordMessageReq() operation was called

See Also:
Constant Field Values

UI_ERROR_NO_SPACE_AVAILABLE

public static final org.csapi.jr.se.ui.UIError UI_ERROR_NO_SPACE_AVAILABLE
There is no more storage capacity to record the message when the recordMessageReq() operation was called


_UI_ERROR_RESOURCE_TIMEOUT

public static final int _UI_ERROR_RESOURCE_TIMEOUT
The request has been accepted by the resource but it did not report a result.

See Also:
Constant Field Values

UI_ERROR_RESOURCE_TIMEOUT

public static final org.csapi.jr.se.ui.UIError UI_ERROR_RESOURCE_TIMEOUT
The request has been accepted by the resource but it did not report a result.

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

getObject

public static org.csapi.jr.se.ui.UIError getObject(int value)
                                            throws InvalidEnumValueException
Accepts values in the range of 0 to 9

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