com.bmc.arsys.api
Class RunMacroAction

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

All Implemented Interfaces:

ActiveLinkAction, Serializable, Cloneable

public class RunMacroAction
extends Action
implements ActiveLinkAction, Cloneable, Serializable

The ActiveLinkMacroInfo class lets you specify a macro to run whenever the active link is executed. The macro can perform any operation or series of operations. If the macro contains parameters, you can specify values for those parameters, including a value from a field in the current request.

See Also:

Serialized Form

Constructor Summary

RunMacroAction()
constructor

RunMacroAction(String macroName, String macroText, Map<String,String> macroParms)

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.
String	getMacroName() Returns name of the macro.
Map<String,String>	getMacroParms() Returns an array of MacroParmInfo objects.
String	getMacroText() Returns macro text.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setMacroName(String macroName) Sets name of the macro.
void	setMacroParms(Map<String,String> macroParms) Sets parameter information.
void	setMacroText(String macroText) Sets macro text.
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

RunMacroAction

public RunMacroAction()

constructor

RunMacroAction

public RunMacroAction(String macroName,
                      String macroText,
                      Map<String,String> macroParms)

Method Detail

getMacroName

public String getMacroName()

Returns name of the macro.

setMacroName

public void setMacroName(String macroName)

Sets name of the macro.

getMacroText

public String getMacroText()

Returns macro text.

setMacroText

public void setMacroText(String macroText)

Sets macro text.

getMacroParms

public Map<String,String> getMacroParms()

Returns an array of MacroParmInfo objects.

setMacroParms

public void setMacroParms(Map<String,String> macroParms)

Sets parameter information.

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