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 the 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 any appended text.
long	getMessageNum() Returns message number.
java.lang.String	getMessageText() Returns message text.
int	getMessageType() Returns type of message.
void	setAppendedText(java.lang.String appendedText) Sets any appended text.
void	setMessageNum(long messageNum) Sets message number.
void	setMessageText(java.lang.String messageText) Sets message text.
void	setMessageType(int messageType) Sets 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 type of message. For example, AR_RETURN_OK if successful; otherwise, AR_RETURN_ERROR if failure.

setMessageType

public void setMessageType(int messageType)

Sets type of message.

getMessageNum

public long getMessageNum()

Returns message number.

setMessageNum

public void setMessageNum(long messageNum)

Sets message number.

getMessageText

public java.lang.String getMessageText()

Returns message text.

setMessageText

public void setMessageText(java.lang.String messageText)

Sets message text.

getAppendedText

public java.lang.String getAppendedText()

Returns any appended text.

setAppendedText

public void setAppendedText(java.lang.String appendedText)

Sets any appended text.

toString

public java.lang.String toString()

Returns in a String object all of the status messages.

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Makes a copy of the object.

Overrides:

clone in class java.lang.Object