com.bmc.arsys.api
Class StatusInfo

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

All Implemented Interfaces:

Serializable, Cloneable

public class StatusInfo
extends Object
implements Cloneable, Serializable

The StatusInfo class represents a message generated by a function call. Nearly every API function has a status parameter as its last return value. This parameter contains status information about the success or failure of the call. StatusInfo consists of zero or more ARStatusStructitems. Each ARStatusStruct item represents a message that the function call generates, and consists of the following elements:

• Message Type: An integer value that indicates the type of message being returned.
• Message Number: The error number associated with the message.
• Message Text: The message text in the language that the ARControlStruct specifies (if possible). To get the text of the message in the local language, call ARGetTextForErrorMessage.
• Appended Text: It is the text that augments the message text. This text might come from the AR System server, the operating system, or database management system. The AR_MAX_MESSAGE_SIZE limits the length to 255 bytes.

0	AR_RETURN_OK	Operation successful—status might contain one or more informational messages.
1	AR_RETURN_WARNING	Operation successful, but some problems encountered-status contains one or more warning messages and might also contain informational messages.
2	AR_RETURN_ERROR	Operation failed—status contains one or more error messages and might also contain warning or informational messages.
3	AR_RETURN_FATAL	Operation failed—status might contain one or more messages.
4	AR_RETURN_BAD_STATUS	Invalid status parameter—operation canceled.
5	AR_RETURN_PROMPT	Status for the active link action.
6	AR_RETURN_ACCESSIBLE	Status message for client accessibility

See Also:

Serialized Form

Constructor Summary

StatusInfo()
constructor

StatusInfo(int messageType, long messageNum, String appendedText)

StatusInfo(int messageType, long messageNum, String messageText, String appendedText)

StatusInfo(long messageNum, Locale locale)

Method Summary

Object	clone() Clone implementation that returns an Object with data cloned from self.
boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
String	getAppendedText() Returns the text that augments the message text.
long	getMessageNum() Returns error number associated with the message.
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.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setAppendedText(String appendedText) Sets the text that augments the message text.
void	setMessageNum(long messageNum) Sets error number associated with the message.
void	setMessageText(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.
String	toString() Returns in a String object that containing all of the status messages.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StatusInfo

public StatusInfo()

constructor

StatusInfo

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

StatusInfo

public StatusInfo(int messageType,
                  long messageNum,
                  String appendedText)

StatusInfo

public StatusInfo(long messageNum,
                  Locale locale)

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 String getMessageText()

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

setMessageText

public void setMessageText(String messageText)

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

getAppendedText

public 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(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 String toString()

Returns in a String object that containing all of the status messages.

Overrides:

toString in class Object

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class Object

Returns:

returns the hash code for this instance

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:

equals in class Object

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal