com.tibco.rta.runtime.model.rule
Class AbstractActionImpl

java.lang.Object
  com.tibco.rta.runtime.model.rule.AbstractActionImpl

All Implemented Interfaces:

Action

public abstract class AbstractActionImpl
extends java.lang.Object
implements Action

Action implementations must extend this class.

Constructor Summary

AbstractActionImpl(Rule rule, ActionDef actionDef)

Method Summary

void	addFunctionParamVal(FunctionDescriptor.FunctionParamValue val) When the action class is initialized by the framework, this method is used to set the action function parameter.
ActionDef	getActionDef() Gets the associated action definition
abstract java.lang.String	getAlertDetails() Gets the alert details such as other supplementary information such as email ids, etc.
java.lang.String	getAlertLevel() Gets the alert level from the underlying ActionDef
abstract java.lang.String	getAlertText() Gets the associated Alert Text.
FunctionDescriptor.FunctionParamValue	getFunctionParamValue(java.lang.String paramName) Returns the values for the given parameter
java.util.Collection<FunctionDescriptor.FunctionParamValue>	getFunctionParamValues() Returns all the function parameter values.
java.lang.String	getName() Gets the name of the action, if any.
boolean	isSetAction() Returns true if this is a Set action, false if it is a Clear action
void	setActionDef(ActionDef actionDef) Set the action definition
void	setSetAction(boolean isSetAction) Set to true if this is a Set action

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tibco.rta.runtime.model.rule.Action

getActionHandlerContext, getAlertType, performAction

Constructor Detail

AbstractActionImpl

public AbstractActionImpl(Rule rule,
                          ActionDef actionDef)

Method Detail

getFunctionParamValues

public java.util.Collection<FunctionDescriptor.FunctionParamValue> getFunctionParamValues()

Description copied from interface: Action

Returns all the function parameter values.

Specified by:

getFunctionParamValues in interface Action

Returns:

the associated function parameter value.

getFunctionParamValue

public FunctionDescriptor.FunctionParamValue getFunctionParamValue(java.lang.String paramName)

Description copied from interface: Action

Returns the values for the given parameter

Specified by:

getFunctionParamValue in interface Action

Parameters:

paramName - the parameter to use.

Returns:

the associated value.

addFunctionParamVal

public void addFunctionParamVal(FunctionDescriptor.FunctionParamValue val)

Description copied from interface: Action

When the action class is initialized by the framework, this method is used to set the action function parameter.

Specified by:

addFunctionParamVal in interface Action

getActionDef

public ActionDef getActionDef()

Description copied from interface: Action

Gets the associated action definition

Specified by:

getActionDef in interface Action

Returns:

setActionDef

public void setActionDef(ActionDef actionDef)

Description copied from interface: Action

Set the action definition

Specified by:

setActionDef in interface Action

Parameters:

actionDef - the action definition to associate.

getName

public java.lang.String getName()

Description copied from interface: Action

Gets the name of the action, if any.

Specified by:

getName in interface Action

Returns:

the action name.

isSetAction

public boolean isSetAction()

Description copied from interface: Action

Returns true if this is a Set action, false if it is a Clear action

Specified by:

isSetAction in interface Action

Returns:

setSetAction

public void setSetAction(boolean isSetAction)

Description copied from interface: Action

Set to true if this is a Set action

Specified by:

setSetAction in interface Action

getAlertText

public abstract java.lang.String getAlertText()

Description copied from interface: Action

Gets the associated Alert Text. This is used by the system to store as part of the Alert logs.

Specified by:

getAlertText in interface Action

Returns:

getAlertDetails

public abstract java.lang.String getAlertDetails()

Description copied from interface: Action

Gets the alert details such as other supplementary information such as email ids, etc. This is a string which is specific to each action.

Specified by:

getAlertDetails in interface Action

Returns:

Gets the alert details

getAlertLevel

public java.lang.String getAlertLevel()

Description copied from interface: Action

Gets the alert level from the underlying ActionDef

Specified by:

getAlertLevel in interface Action

Returns:

the alert level for this action.