com.monad.homerun.objmgt
Interface ActionService

All Superinterfaces:

ManagedService

public interface ActionService
extends ManagedService

ActionService describes the methods any action manager must support

Method Summary

boolean	addMonth(Month month)
boolean	addPlan(Plan plan)
boolean	addRule(Rule rule)
boolean	addSchedule(Schedule schedule)
void	applyCalendar()
boolean	applyRule(Rule rule, java.util.Map<java.lang.String,java.lang.Object> context) Invokes an action rule in designated mode
boolean	applyRule(java.lang.String category, java.lang.String ruleName, java.util.Map<java.lang.String,java.lang.Object> context) Invokes an action rule by name
void	enableCalendar(boolean enable)
void	evaluateCalendar()
void	evaluateSchedule()
java.lang.String[]	getActivePlanNames()
java.lang.String	getActiveScheduleName()
Month	getMonth(java.lang.String monthName)
java.lang.String[]	getMonthNames()
Plan	getPlan(java.lang.String planName)
java.lang.String[]	getPlanNames() Returns the names of all defined event plans
Rule	getRule(java.lang.String category, java.lang.String ruleName)
java.lang.String[]	getRuleBindingVariables(java.lang.String category, java.lang.String ruleName) Returns array of binding variables for the rule
java.lang.String[]	getRuleCategories() Returns a list of rule categories
java.lang.String[]	getRuleNames(java.lang.String category) Returns a list of action rules in given category
Schedule	getSchedule(java.lang.String scheduleName)
java.lang.String[]	getScheduleNames()
TraceContext	getTraceContext(java.lang.String contextID)
TraceDescription[]	getTraceDescriptions()
boolean	isRuleStartable(java.lang.String category, java.lang.String ruleName) Deprecated.
boolean	removeMonth(Month month)
boolean	removePlan(java.lang.String planName)
boolean	removeRule(java.lang.String category, java.lang.String ruleName)
boolean	removeSchedule(java.lang.String scheduleName)
boolean	ruleExists(java.lang.String ruleName) Tests for the existence of an action rule
boolean	runPlan(java.lang.String planName)
boolean	startSchedule(java.lang.String scheduleName)
void	startTracing(java.lang.String category, java.lang.String ruleName)
void	stopPlan(java.lang.String planName)
void	stopSchedule()
void	stopTracing(java.lang.String category, java.lang.String ruleName)
RuleTrace	traceRule(Rule rule, RuleTrace trace) Traces an action rule
boolean	updateMonth(Month month)
boolean	updatePlan(Plan plan)
boolean	updateRule(Rule rule)
boolean	updateSchedule(Schedule schedule)
boolean	validateMonth(java.lang.String monthName)
boolean	validatePlan(java.lang.String planName)
boolean	validateSchedule(java.lang.String scheduleName)

Methods inherited from interface com.monad.homerun.core.ManagedService

init, shutdown

Method Detail

getRuleCategories

java.lang.String[] getRuleCategories()

Returns a list of rule categories

Returns:

category list list of categories

getRuleNames

java.lang.String[] getRuleNames(java.lang.String category)

Returns a list of action rules in given category

Parameters:

category - the rule category

Returns:

rule list list of action rule names

ruleExists

boolean ruleExists(java.lang.String ruleName)

Tests for the existence of an action rule

Parameters:

ruleName - the name of the rule

Returns:

true if rule exists in any category, else false

isRuleStartable

@Deprecated
boolean isRuleStartable(java.lang.String category,
                                   java.lang.String ruleName)

Deprecated.

Returns whether an action rule may be started (as opposed to just run)

Parameters:

category - the rule category

ruleName - the action rule name

Returns:

true if rule can be started, else false

getRuleBindingVariables

java.lang.String[] getRuleBindingVariables(java.lang.String category,
                                           java.lang.String ruleName)

Returns array of binding variables for the rule

Parameters:

category - the rule category

ruleName - the action rule name

Returns:

array of variable names

applyRule

boolean applyRule(Rule rule,
                  java.util.Map<java.lang.String,java.lang.Object> context)

Invokes an action rule in designated mode

Parameters:

rule - the action rule

context - invocation context should include at least mode ("apply" "perform" or "validate")

Returns:

true if invocation successful, else false

applyRule

boolean applyRule(java.lang.String category,
                  java.lang.String ruleName,
                  java.util.Map<java.lang.String,java.lang.Object> context)

Invokes an action rule by name

Parameters:

category - the action rule category

ruleName - the action rule name

context - invocation context should include at least mode ("apply" "perform" or "validate")

Returns:

true if invocation successful, else false

traceRule

RuleTrace traceRule(Rule rule,
                    RuleTrace trace)

Traces an action rule

Parameters:

rule - the action rule

context - invocation context should include at least mode ("apply" "perform" or "validate")

Returns:

trace a trace of rule invocation

getTraceDescriptions

TraceDescription[] getTraceDescriptions()

getTraceContext

TraceContext getTraceContext(java.lang.String contextID)

startTracing

void startTracing(java.lang.String category,
                  java.lang.String ruleName)

stopTracing

void stopTracing(java.lang.String category,
                 java.lang.String ruleName)

getRule

Rule getRule(java.lang.String category,
             java.lang.String ruleName)

addRule

boolean addRule(Rule rule)

updateRule

boolean updateRule(Rule rule)

removeRule

boolean removeRule(java.lang.String category,
                   java.lang.String ruleName)

startSchedule

boolean startSchedule(java.lang.String scheduleName)

stopSchedule

void stopSchedule()

getScheduleNames

java.lang.String[] getScheduleNames()

getActiveScheduleName

java.lang.String getActiveScheduleName()

getSchedule

Schedule getSchedule(java.lang.String scheduleName)

addSchedule

boolean addSchedule(Schedule schedule)

updateSchedule

boolean updateSchedule(Schedule schedule)

removeSchedule

boolean removeSchedule(java.lang.String scheduleName)

validateSchedule

boolean validateSchedule(java.lang.String scheduleName)

evaluateSchedule

void evaluateSchedule()

getMonthNames

java.lang.String[] getMonthNames()

getMonth

Month getMonth(java.lang.String monthName)

addMonth

boolean addMonth(Month month)

updateMonth

boolean updateMonth(Month month)

removeMonth

boolean removeMonth(Month month)

validateMonth

boolean validateMonth(java.lang.String monthName)

enableCalendar

void enableCalendar(boolean enable)

applyCalendar

void applyCalendar()

evaluateCalendar

void evaluateCalendar()

runPlan

boolean runPlan(java.lang.String planName)

stopPlan

void stopPlan(java.lang.String planName)

getPlanNames

java.lang.String[] getPlanNames()

Returns the names of all defined event plans

Returns:

plan names array of all defined plan names

getActivePlanNames

java.lang.String[] getActivePlanNames()

getPlan

Plan getPlan(java.lang.String planName)

addPlan

boolean addPlan(Plan plan)

updatePlan

boolean updatePlan(Plan plan)

removePlan

boolean removePlan(java.lang.String planName)

validatePlan

boolean validatePlan(java.lang.String planName)