RuleRepositoryService

• selectContext
• getAgendaTree
• getAgendaTrees
• getRule
• getRules

• ContextDefinition
• ContextSelectionCriteria
• AgendaTreeDefinition
• RuleDefinition

Method	selectContext
Description	Locates a ContextDefinition based on the given map of context qualifiers. The requirements for valid selection criteria are implementation dependent. An IllegalArgumentException may be thrown if the implementation can't operate with the given criteria.
Parameters	ContextSelectionCriteria	contextSelectionCriteria	???
Return	ContextDefinition		???
Errors	RiceIllegalArgumentException		if the implementation can't handle the given ContextSelectionCriteria

Back to Operations

Method	getAgendaTree
Description	Retrieves the agenda tree for the given agendaId. The agenda tree includes the entire agenda definition in the appropriate order and with the defined agenda branching.
Parameters	String	agendaId	the id of the agenda for which to retrieve the agenda tree
Return	AgendaTreeDefinition		the agenda tree, or null if no agenda could be located for the given agendaId
Errors	RiceIllegalArgumentException		if the given agendaId is null

Back to Operations

Method	getAgendaTrees
Description	Retrieves all of the agendas trees for the given list of agendaIds. The agenda tree includes the entire agenda definition in the appropriate order and with the defined agenda branching. The list which is returned from this operation may not be the same size as the list which is passed to this method. If an agenda doesn't exist for a given agenda id then no result for that id will be returned in the list. As a result of this, the returned list can be empty, but it will never be null.
Parameters	StringList	agendaIds	the list of agenda ids for which to retrieve the agenda trees
Return	AgendaTreeDefinitionList		the list of agenda trees for the given ids, this list will only contain agenda trees for the ids that were resolved successfully, it will never return null but could return an empty list if no agenda trees could be loaded for the given set of ids
Errors	RiceIllegalArgumentException		if the given list of agendaIds is null

Back to Operations

Method	getRule
Description	Retrieves the rule for the given ruleId. The rule includes the propositions which define the condition that is to be evaluated on the rule. It also defines a collection of actions which will be invoked if the rule succeeds.
Parameters	String	ruleId	the id of the rule to retrieve
Return	RuleDefinition		the rule definition, or null if no rule could be located for the given ruleId
Errors	RiceIllegalArgumentException		if the given ruleId is null

Back to Operations

Method	getRules
Description	Retrieves all of the rules for the given list of ruleIds. The rule includes the propositions which define the condition that is to be evaluated on the rule. It also defines a collection of actions which will be invoked if the rule succeeds. The list which is returned from this operation may not be the same size as the list which is passed to this method. If a rule doesn't exist for a given rule id then no result for that id will be returned in the list. As a result of this, the returned list can be empty, but it will never be null.
Parameters	StringList	ruleIds	the list of rule ids for which to retrieve the rules
Return	RuleDefinitionList		the list of rules for the given ids, this list will only contain rules for the ids that were resolved successfully, it will never return null but could return an empty list if no rules could be loaded for the given set of ids
Errors	RiceIllegalArgumentException		if the given list of ruleIds is null

Back to Operations