public class MessageAction extends Action implements ActiveLinkAction, Cloneable, Serializable
MessageAction
class is used to
define the message information that is generally used to
display an interactive error, warning, or note. You can also define the extra help text that appears
in the Remedy User prompt bar to guide users through a series of forms.Constructor and Description |
---|
MessageAction()
constructor
|
MessageAction(int messageType,
int messageNum,
String messageText,
boolean usePromptingPane)
Constructs a new
MessageAction object
with the following parameters: |
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Clone implementation that returns an Object with data cloned from self.
|
boolean |
equals(Object obj)
Use this method for checking equality.
|
int |
getMessageNum()
Returns number associated with the message in Message filter action.
|
String |
getMessageText()
Returns text of Message filter action corresponding to message number.
|
int |
getMessageType() |
int |
hashCode()
Returns the hash code value for this instance of the current class.
|
boolean |
isUsePromptingPane()
Returns the
usePromptingPane flag. |
void |
setMessageNum(int messageNum)
Sets number associated with the message in Message filter action.
|
void |
setMessageText(String messageText)
Sets message text for Message filter action.
|
void |
setMessageType(int messageType)
Sets type of Message filter action.
|
void |
setUsePromptingPane(boolean usePromptingPane)
Sets the flag used to define how and when the message should be displayed.
|
String |
toString()
Returns a string description of the object.
|
equals, getActionType
public MessageAction()
public MessageAction(int messageType, int messageNum, String messageText, boolean usePromptingPane)
MessageAction
object
with the following parameters:messageType
- Type of Message filter actionmessageNum
- Number of Message filter actionmessageText
- Text of Message filter actionpublic int getMessageType()
AR_RETURN_OK
indicates operation is successful-status may contain one or
more informational messages.
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.
AR_RETURN_ERROR
indicates operation failed-status may contain one or
more error messages and may also contain warning or informational messages.
AR_RETURN_FATAL
indicates operation failed-status may contain one or
more messages.
AR_RETURN_BAD_STATUS
indicates invalid status parameter-operation cancelled.
AR_RETURN_PROMPT
indicates status message for the active link message action type prompt.
AR_RETURN_ACCESSIBLE
indicates status message for client accessibility.
AR_RETURN_TOOLTIP
indicates status message for the active link message action type Tooltip.
public void setMessageType(int messageType)
getMessageType()
for possible values.public int getMessageNum()
public void setMessageNum(int messageNum)
public String getMessageText()
public void setMessageText(String messageText)
public boolean isUsePromptingPane()
usePromptingPane
flag. (active links only)public void setUsePromptingPane(boolean usePromptingPane)
public Object clone() throws CloneNotSupportedException
clone
in class Action
CloneNotSupportedException
public boolean equals(Object obj)
public int hashCode()
? Copyright 2013 BMC Software, Inc.