com.remedy.arsys.api
Class FilterStatusInfo

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

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

MessageInfo

public class FilterStatusInfo

extends java.lang.Object

implements java.lang.Cloneable

The FilterStatusInfo class returns the type of filter message error generated by a function call.

Constructor Summary

FilterStatusInfo()
constructor

FilterStatusInfo(long messageType, long messageNum, java.lang.String messageText)
Constructs a new FilterStatusInfo object with the following parameters:

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self
boolean	equals(java.lang.Object anObject) Use this method for checking equality.
long	getMessageNum() Returns number associated with the message in Message filter action.
java.lang.String	getMessageText() Returns text of Message filter action corresponding to message number.
long	getMessageType() Returns type of Message filter action.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setMessageNum(long messageNum) Sets number associated with the message in Message filter action.
void	setMessageText(java.lang.String messageText) Sets message text for Message filter action.
void	setMessageType(long messageType) Sets type of Message filter action.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterStatusInfo

public FilterStatusInfo()

constructor

FilterStatusInfo

public FilterStatusInfo(long messageType,
                        long messageNum,
                        java.lang.String messageText)

Constructs a new FilterStatusInfo object with the following parameters:

Parameters:

messageType - Type of Message filter action

messageNum - Number of Message filter action

messageText - Text of Message filter action

Method Detail

getMessageType

public long getMessageType()

Returns type of Message filter action. Possible values include the following:

Parameters:

0 - AR_RETURN_OK indicates operation is successful—status may contain one or more informational messages.

1 - AR_RETURN_WARNING indicates operation is successful but some problems encountered—status may contain one or more warning messages and may also contain information messages.

2 - AR_RETURN_ERROR indicates operation failed—status may contain one or more error messages and may also contain warning or informational messages.

3 - AR_RETURN_FATAL indicates operation failed—status may contain one or more messages.

4 - AR_RETURN_BAD_STATUS indicates invalid status parameter-operation cancelled.

setMessageType

public void setMessageType(long messageType)

Sets type of Message filter action. See getMessageType() for possible values.

getMessageNum

public long getMessageNum()

Returns number associated with the message in Message filter action.

setMessageNum

public void setMessageNum(long messageNum)

Sets number associated with the message in Message filter action.

getMessageText

public java.lang.String getMessageText()

Returns text of Message filter action corresponding to message number. To get the text of the message in the local language, call ARGetTextForErrorMessage.

setMessageText

public void setMessageText(java.lang.String messageText)

Sets message text for Message filter action. To set the text of the message in the local language, call ARGetTextForErrorMessage.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object anObject)

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

Overrides:

equals in class java.lang.Object

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 java.lang.Object