com.tibco.rta.runtime.model.rule
Interface Action

All Known Implementing Classes:

AbstractActionImpl

public interface Action

A runtime rule action interface. Implementation should provide an instance of this interface via the ActionHandlerContext.getAction interface.

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
ActionHandlerContext	getActionHandlerContext() Gets the associated context handler.
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
java.lang.String	getAlertText() Gets the associated Alert Text.
java.lang.String	getAlertType() Gets the type of the action, if any.
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	performAction(Rule rule, MetricNodeEvent node) Perform the action.
void	setActionDef(ActionDef actionDef) Set the action definition
void	setSetAction(boolean isSetAction) Set to true if this is a Set action

Method Detail

getActionHandlerContext

ActionHandlerContext getActionHandlerContext()

Gets the associated context handler.

Returns:

the context handler.

performAction

void performAction(Rule rule,
                   MetricNodeEvent node)
                   throws java.lang.Exception

Perform the action. It is called by the engine when thier associated rules filter criteria is passed.

Parameters:

rule - the rule that triggered this action.

node - the node event that triggered this action.

Throws:

java.lang.Exception

addFunctionParamVal

void addFunctionParamVal(FunctionDescriptor.FunctionParamValue val)

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

getFunctionParamValues

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

Returns all the function parameter values.

Returns:

the associated function parameter value.

getFunctionParamValue

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

Returns the values for the given parameter

Parameters:

paramName - the parameter to use.

Returns:

the associated value.

setActionDef

void setActionDef(ActionDef actionDef)

Set the action definition

Parameters:

actionDef - the action definition to associate.

getActionDef

ActionDef getActionDef()

Gets the associated action definition

Returns:

getName

java.lang.String getName()

Gets the name of the action, if any.

Returns:

the action name.

getAlertType

java.lang.String getAlertType()

Gets the type of the action, if any. e.g : Email/Log/Custom

Returns:

the action type.

isSetAction

boolean isSetAction()

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

Returns:

setSetAction

void setSetAction(boolean isSetAction)

Set to true if this is a Set action

Parameters:

isSetAction -

getAlertText

java.lang.String getAlertText()

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

Returns:

getAlertLevel

java.lang.String getAlertLevel()

Gets the alert level from the underlying ActionDef

Returns:

the alert level for this action.

getAlertDetails

java.lang.String getAlertDetails()

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

Returns:

Gets the alert details