|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
(C) Copyright International Business Machines Corporation, 2000
Generic Interface to represent a Rule.
This interface is mainly the glue between a Parser and an Engine:
a Parser plug-ins give an com.tivoli.zce.IRule
object to the
com.tivoli.zce.engine.IEngine
plug-ins.
Field Summary | |
static java.lang.String |
IBM_Copyright
|
Method Summary | |
void |
addAction(java.lang.String function,
java.lang.String parameters,
boolean multipleInstance)
add an action to the current Rule |
void |
addPredicate(com.tivoli.zce.predicates.IPredicate predicate)
add a predicate in the list of predicates |
boolean |
getDirectAccess()
|
com.tivoli.zce.engine.IEngine |
getEngine()
|
java.util.ArrayList |
getEventTypes()
Return the event types to which this rule applies to. |
com.tivoli.zce.predicates.IPredicate[] |
getPredicates()
|
java.lang.String |
getRuleID()
Return the identifier for this rule; an identifier could be hierarchical using "." as separator between each level. |
java.lang.String |
getStringForm()
Return the String representation of the rule, as set by |
com.tivoli.zce.Variable |
getVar(java.lang.String var)
|
boolean |
isElseType()
|
void |
remove()
Remove this rule and update all associated Objects (actions) |
void |
setDirectAccess(boolean directAccess)
set the direct access properties, i.e., a rule with this property set to false is not registered into any RuleProcessor , it could be only
triggered internally via actions. |
void |
setElseType(boolean elseRule)
An else rule is processes an event only if this event was not matched by any normal rules. |
void |
setEngine(com.tivoli.zce.engine.IEngine engine)
set the engine attached to this rule |
void |
setEventTypes(java.util.ArrayList type)
Set the types of events applicable to this rule |
void |
setRuleID(java.lang.String id)
Change the identifier for this rule, this method uses the same syntax as |
void |
setStringForm(java.lang.String rule)
set the display representation of a rule |
Methods inherited from interface com.tivoli.zce.IEventSender |
addEventProcessor, getEventProcessor, removeEventProcessor |
Methods inherited from interface com.tivoli.zce.IEventProcessor |
processEvent, processEvents |
Field Detail |
public static final java.lang.String IBM_Copyright
Method Detail |
public java.util.ArrayList getEventTypes()
Event types
this rule applies topublic java.lang.String getRuleID()
"."
as separator between each level.public void setRuleID(java.lang.String id)
id
- the new identifier for this rulegetRuleID()
public void remove()
public com.tivoli.zce.engine.IEngine getEngine()
public void setEngine(com.tivoli.zce.engine.IEngine engine)
engine
- public void setDirectAccess(boolean directAccess)
RuleProcessor
, it could be only
triggered internally via actions.directAccess
- public boolean getDirectAccess()
setDirectAccess(boolean directAccess)
public void setElseType(boolean elseRule)
elseRule
- true to set this rule as a else rulepublic boolean isElseType()
setElseType(boolean elseRule)
public void setStringForm(java.lang.String rule)
public java.lang.String getStringForm()
String
representation of the rule, as set bysetStringForm(String rule)
public void setEventTypes(java.util.ArrayList type)
types
- Event types this rule should receivepublic com.tivoli.zce.predicates.IPredicate[] getPredicates()
public void addPredicate(com.tivoli.zce.predicates.IPredicate predicate)
public void addAction(java.lang.String function, java.lang.String parameters, boolean multipleInstance) throws java.lang.Exception
Rule
function
- the action nameparameters
- the parameters for this actionmultipleInstance
- this parameter specifies if the action should be
replicated at each usage, or if only one instance of it will be used for
every Rule attach to it. In a single instance
mode,
parameters
will be process only at the first creation of the action.public com.tivoli.zce.Variable getVar(java.lang.String var) throws java.lang.Exception
var
- the name of the variable to search for, the variable could contains "."
characters for hierarchical specification as Rule
name, but cannot refer
directly to a Rule, but only to folder
.- Returns:
- the variable or null if none was found
- Throws:
java.lang.Exception
- an exception could be raised if the variable name refere to an unknown
Rule path
.
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |