com.bmc.arsys.api
Class MessageAction

java.lang.Object
  com.bmc.arsys.api.Action
      com.bmc.arsys.api.MessageAction

All Implemented Interfaces:

ActiveLinkAction, Serializable, Cloneable

public class MessageAction
extends Action
implements ActiveLinkAction, Cloneable, Serializable

The 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.

See Also:

Serialized Form

Constructor Summary

MessageAction()
constructor

MessageAction(int messageType, int messageNum, String messageText, boolean usePromptingPane)
Constructs a new MessageAction object with the following parameters:

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.
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.

Methods inherited from class com.bmc.arsys.api.Action

equals, getActionType

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageAction

public MessageAction()

constructor

MessageAction

public MessageAction(int messageType,
                     int messageNum,
                     String messageText,
                     boolean usePromptingPane)

Constructs a new MessageAction 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 int getMessageType()

Returns:

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

• 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.
• 5 - AR_RETURN_PROMPT indicates status message for the active link message action type prompt.
• 6 - AR_RETURN_ACCESSIBLE indicates status message for client accessibility.
• 7 - AR_RETURN_TOOLTIP indicates status message for the active link message action type Tooltip.

setMessageType

public void setMessageType(int messageType)

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

getMessageNum

public int getMessageNum()

Returns number associated with the message in Message filter action.

setMessageNum

public void setMessageNum(int messageNum)

Sets number associated with the message in Message filter action.

getMessageText

public String getMessageText()

Returns text of Message filter action corresponding to message number.

setMessageText

public void setMessageText(String messageText)

Sets message text for Message filter action.

isUsePromptingPane

public boolean isUsePromptingPane()

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 Object clone()
             throws CloneNotSupportedException

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

Overrides:

clone in class Action

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

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 Action

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

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 Action

Returns:

returns the hash code for this instance

toString

public String toString()

Description copied from class: Action

Returns a string description of the object.

Overrides:

toString in class Action