COM.TIBCO.hawk.config.rbengine.rulebase

Class ConsequenceAction

java.lang.Object

COM.TIBCO.hawk.config.rbengine.rulebase.RulebaseElement

COM.TIBCO.hawk.config.rbengine.rulebase.Action

COM.TIBCO.hawk.config.rbengine.rulebase.ConsequenceAction

All Implemented Interfaces:

java.lang.Cloneable

public class ConsequenceAction
extends Action

A ConsequenceAction represents an action that a test may execute when it undergoes a F->T or T->T state transition.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CNAME

Constructor Summary

Constructors

Constructor and Description
ConsequenceAction(java.lang.String microAgentName, COM.TIBCO.hawk.talon.MethodInvocation mi) Constructs a ConsequenceAction with default values for the perform action policy (PerformOnceOnly) and escalation period (0).

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a copy of this object
boolean	equals(java.lang.Object obj) Compares two ConsequenceActions for equality.
int	getEscalationTime() Returns the escalation time of this action.
PerformActionPolicy	getPerformActionPolicy() Returns the perform action policy.
void	setEscalationTime(int sec) Sets the escalation time of this action.
void	setPerformActionPolicy(PerformActionPolicy policy) Sets the perform action policy.
java.lang.String	toString() Returns string representation of this action.

Methods inherited from class COM.TIBCO.hawk.config.rbengine.rulebase.Action

getMethodInvocation, getMicroAgentName, getProperties, setMethodInvocation, setMicroAgentName, setProperties

Methods inherited from class COM.TIBCO.hawk.config.rbengine.rulebase.RulebaseElement

getName, getSchedule, setName, setSchedule

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CNAME

public static java.lang.String CNAME

Constructor Detail

ConsequenceAction

public ConsequenceAction(java.lang.String microAgentName,
                         COM.TIBCO.hawk.talon.MethodInvocation mi)
                  throws java.lang.IllegalArgumentException

Constructs a ConsequenceAction with default values for the perform action policy (PerformOnceOnly) and escalation period (0).

Parameters:

microAgentName - microagent name for this action, must not be null or empty string

mi - method invocation for this action

Throws:

java.lang.IllegalArgumentException - if microagent name is null or empty string

java.lang.IllegalArgumentException - if method invocation is null

Method Detail

getEscalationTime

public int getEscalationTime()

Returns the escalation time of this action.

setEscalationTime

public void setEscalationTime(int sec)

Sets the escalation time of this action.

Parameters:

sec - the escalation time in seconds.

Throws:

java.lang.IllegalArgumentException - if time is negative.

setPerformActionPolicy

public void setPerformActionPolicy(PerformActionPolicy policy)

Sets the perform action policy. The only supported perform action policy types are PerformOnceOnly, PerformAlways, and PerformCountOnInterval.

Throws:

java.lang.IllegalArgumentException - of the perform action policy is not one of the supported policies.

getPerformActionPolicy

public PerformActionPolicy getPerformActionPolicy()

Returns the perform action policy.

toString

public java.lang.String toString()

Returns string representation of this action.

Overrides:

toString in class Action

equals

public boolean equals(java.lang.Object obj)

Compares two ConsequenceActions for equality.

Overrides:

equals in class Action

clone

public java.lang.Object clone()

Returns a copy of this object

Specified by:

clone in class RulebaseElement