com.remedy.arsys.api
Class StatusInfo

java.lang.Object
  com.remedy.arsys.api.StatusInfo

All Implemented Interfaces:

java.lang.Cloneable

public class StatusInfo

extends java.lang.Object

implements java.lang.Cloneable

The StatusInfo class represents a message generated by a function call.

Constructor Summary

StatusInfo()
constructor

StatusInfo(int messageType, long messageNum, java.lang.String messageText, java.lang.String appendedText)

Method Summary

java.lang.Object	clone() Makes a copy of the object.
java.lang.String	getAppendedText() Returns the text that augments the message text.
long	getMessageNum() Returns error number associated with the message.
java.lang.String	getMessageText() Returns message text corresponding to message number in the language specified in ARServerUser.
int	getMessageType() Returns integer value indicating the type of message.
void	setAppendedText(java.lang.String appendedText) Sets the text that augments the message text.
void	setMessageNum(long messageNum) Sets error number associated with the message.
void	setMessageText(java.lang.String messageText) Sets message text corresponding to message number in the language specified in ARServerUser.
void	setMessageType(int messageType) Sets integer value indicating the type of message.
java.lang.String	toString() Returns in a String object all of the status messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusInfo

public StatusInfo()

constructor

StatusInfo

public StatusInfo(int messageType,
                  long messageNum,
                  java.lang.String messageText,
                  java.lang.String appendedText)

Method Detail

getMessageType

public int getMessageType()

Returns integer value indicating the type of message. 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.

setMessageType

public void setMessageType(int messageType)

Sets integer value indicating the type of message. See getMessageType() for possible values.

getMessageNum

public long getMessageNum()

Returns error number associated with the message.

setMessageNum

public void setMessageNum(long messageNum)

Sets error number associated with the message.

getMessageText

public java.lang.String getMessageText()

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

setMessageText

public void setMessageText(java.lang.String messageText)

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

getAppendedText

public java.lang.String getAppendedText()

Returns the 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).

setAppendedText

public void setAppendedText(java.lang.String appendedText)

Sets the 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).

toString

public java.lang.String toString()

Returns in a String object all of the status messages.

clone

public java.lang.Object clone()

Makes a copy of the object.