com.remedy.arsys.api
Class Status

java.lang.Object
  |
  +--com.remedy.arsys.api.Status

All Implemented Interfaces:

java.lang.Cloneable

public class Status

extends java.lang.Object

implements java.lang.Cloneable

The Status class represents a message generated by a function call and consists of four elements:

• m_messageType -- Integer value indicating the type of message being returned.
• m_messageNum -- Error number associated with the message
• m_messageText -- Message text in the language specified in ARServerUser.
• m_appendedText -- Text that augments the message text.

Field Summary

java.lang.String	m_appendedText Text that augments the message text.
long	m_messageNum Error number associated with the message
java.lang.String	m_messageText Message text corresponding to message number in the language specified in ARServerUser.
int	m_messageType Integer value indicating the type of message being returned.

Constructor Summary

Status(int nMessageType, long lMessageNum, java.lang.String messageText, java.lang.String appendText)

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self
java.lang.String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_messageType

public int m_messageType

Integer value indicating the type of message being returned. Possible values include the following:

• Constants.AR_RETURN_OK -- Operation successful — status may contain one or more informational messages.
• Constants.AR_RETURN_WARNING -- Operation successful, but some problem encountered — status contains one or more warning messages and may also contain informational messages.
• Constants.AR_RETURN_ERROR -- Operation failed — status contains one or more error messages and may also contain warning or informational messages.
• Constants.AR_RETURN_FATAL -- Operation failed — status may contain one or more messages.
• Constants.AR_RETURN_BAD_STATUS -- Invalid status parameter — operation cancelled.
• Constants.AR_RETURN_PROMPT -- Active link message action type, prompt message.
• Constants.AR_RETURN_ACCESSIBLE -- Active link message action type, status message for client accessibility.

m_messageNum

public long m_messageNum

Error number associated with the message

m_messageText

public java.lang.String m_messageText

Message text corresponding to message number in the language specified in ARServerUser.

m_appendedText

public java.lang.String m_appendedText

Text that augments the message text. This text may come from the AR System server,the operating system,or database management system.The length is limited by Constants.AR_MAX_MESSAGE_SIZE (255 bytes).

Constructor Detail

Status

public Status(int nMessageType,
              long lMessageNum,
              java.lang.String messageText,
              java.lang.String appendText)

Method Detail

toString

public java.lang.String toString()

Returns a string description of the object.

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class java.lang.Object