com.remedy.arsys.api
Class MessageInfo

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

All Implemented Interfaces:

java.lang.Cloneable

public class MessageInfo

extends FilterStatusInfo

implements java.lang.Cloneable

The MessageInfo class is used to define the message information which is generally used to display an interactive error, warning, or note. You can also define the extra help text that appears in the AR System User prompt bar to guide users through a series of forms.

Constructor Summary

MessageInfo()
constructor

MessageInfo(long messageType, long messageNum, java.lang.String messageText, boolean usePromptingPane)

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.
boolean	getUsePromptingPane() Returns the usePromptingPane flag.
int	hashCode() This method can be used to populate a hash table.
void	setUsePromptingPane(boolean usePromptingPane) Sets the flag used to define how and when the message should be displayed.

Methods inherited from class com.remedy.arsys.api.FilterStatusInfo

getMessageNum, getMessageText, getMessageType, setMessageNum, setMessageText, setMessageType

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageInfo

public MessageInfo()

constructor

MessageInfo

public MessageInfo(long messageType,
                   long messageNum,
                   java.lang.String messageText,
                   boolean usePromptingPane)

Method Detail

getUsePromptingPane

public boolean getUsePromptingPane()

Returns the usePromptingPane flag. (active links only)

setUsePromptingPane

public void setUsePromptingPane(boolean usePromptingPane)

Sets the flag used to define how and when the message should be displayed. (active links only)

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 FilterStatusInfo

equals

public boolean equals(java.lang.Object anObject)

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

Overrides:

equals in class FilterStatusInfo

hashCode

public int hashCode()

This method can be used to populate a hash table. Implicitly used method to test equality of objects.

Overrides:

hashCode in class FilterStatusInfo