org.csapi.jr.se.ui
Class UIReport

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

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

Defines the UI reports if a response was requested.

See Also:
Serialized Form

Field Summary
static int _UI_REPORT_INFO_COLLECTED
          Information collected., meeting the specified criteria.
static int _UI_REPORT_INFO_SENT
          Confirmation that the information has been sent.
static int _UI_REPORT_MESSAGE_DELETED
          A message has been deleted successfully.
static int _UI_REPORT_MESSAGE_NOT_DELETED
          A message has not been deleted successfully.
static int _UI_REPORT_MESSAGE_NOT_STORED
          The message has not been stored successfully.
static int _UI_REPORT_MESSAGE_STORED
          A message has been stored successfully.
static int _UI_REPORT_NO_INPUT
          No information collected.
static int _UI_REPORT_TIMEOUT
          No information collected.
static int _UI_REPORT_UNDEFINED
          Undefined report.
static org.csapi.jr.se.ui.UIReport UI_REPORT_INFO_COLLECTED
          Information collected., meeting the specified criteria.
static org.csapi.jr.se.ui.UIReport UI_REPORT_INFO_SENT
          Confirmation that the information has been sent.
static org.csapi.jr.se.ui.UIReport UI_REPORT_MESSAGE_DELETED
          A message has been deleted successfully.
static org.csapi.jr.se.ui.UIReport UI_REPORT_MESSAGE_NOT_DELETED
          A message has not been deleted successfully.
static org.csapi.jr.se.ui.UIReport UI_REPORT_MESSAGE_NOT_STORED
          The message has not been stored successfully.
static org.csapi.jr.se.ui.UIReport UI_REPORT_MESSAGE_STORED
          A message has been stored successfully.
static org.csapi.jr.se.ui.UIReport UI_REPORT_NO_INPUT
          No information collected.
static org.csapi.jr.se.ui.UIReport UI_REPORT_TIMEOUT
          No information collected.
static org.csapi.jr.se.ui.UIReport UI_REPORT_UNDEFINED
          Undefined report.
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is 'equal to' this one.
static org.csapi.jr.se.ui.UIReport getObject(int value)
          Accepts values in the range of 0 to 8
 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_REPORT_UNDEFINED

public static final int _UI_REPORT_UNDEFINED
Undefined report.

See Also:
Constant Field Values

UI_REPORT_UNDEFINED

public static final org.csapi.jr.se.ui.UIReport UI_REPORT_UNDEFINED
Undefined report.


_UI_REPORT_INFO_SENT

public static final int _UI_REPORT_INFO_SENT
Confirmation that the information has been sent.

See Also:
Constant Field Values

UI_REPORT_INFO_SENT

public static final org.csapi.jr.se.ui.UIReport UI_REPORT_INFO_SENT
Confirmation that the information has been sent.


_UI_REPORT_INFO_COLLECTED

public static final int _UI_REPORT_INFO_COLLECTED
Information collected., meeting the specified criteria.

See Also:
Constant Field Values

UI_REPORT_INFO_COLLECTED

public static final org.csapi.jr.se.ui.UIReport UI_REPORT_INFO_COLLECTED
Information collected., meeting the specified criteria.


_UI_REPORT_NO_INPUT

public static final int _UI_REPORT_NO_INPUT
No information collected. The user immediately entered the delimiter character. No valid information has been returned.

See Also:
Constant Field Values

UI_REPORT_NO_INPUT

public static final org.csapi.jr.se.ui.UIReport UI_REPORT_NO_INPUT
No information collected. The user immediately entered the delimiter character. No valid information has been returned.


_UI_REPORT_TIMEOUT

public static final int _UI_REPORT_TIMEOUT
No information collected. The user did not input any response before the input timeout expired.

See Also:
Constant Field Values

UI_REPORT_TIMEOUT

public static final org.csapi.jr.se.ui.UIReport UI_REPORT_TIMEOUT
No information collected. The user did not input any response before the input timeout expired.


_UI_REPORT_MESSAGE_STORED

public static final int _UI_REPORT_MESSAGE_STORED
A message has been stored successfully.

See Also:
Constant Field Values

UI_REPORT_MESSAGE_STORED

public static final org.csapi.jr.se.ui.UIReport UI_REPORT_MESSAGE_STORED
A message has been stored successfully.


_UI_REPORT_MESSAGE_NOT_STORED

public static final int _UI_REPORT_MESSAGE_NOT_STORED
The message has not been stored successfully.

See Also:
Constant Field Values

UI_REPORT_MESSAGE_NOT_STORED

public static final org.csapi.jr.se.ui.UIReport UI_REPORT_MESSAGE_NOT_STORED
The message has not been stored successfully.


_UI_REPORT_MESSAGE_DELETED

public static final int _UI_REPORT_MESSAGE_DELETED
A message has been deleted successfully.

See Also:
Constant Field Values

UI_REPORT_MESSAGE_DELETED

public static final org.csapi.jr.se.ui.UIReport UI_REPORT_MESSAGE_DELETED
A message has been deleted successfully.


_UI_REPORT_MESSAGE_NOT_DELETED

public static final int _UI_REPORT_MESSAGE_NOT_DELETED
A message has not been deleted successfully.

See Also:
Constant Field Values

UI_REPORT_MESSAGE_NOT_DELETED

public static final org.csapi.jr.se.ui.UIReport UI_REPORT_MESSAGE_NOT_DELETED
A message has not been deleted successfully.

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

getObject

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

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