OSID - osid.OsidRuleQuery Service Interface Definition

Interface	osid.OsidRuleQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidOperableQuery`
Implemented By	`osid.assessment.authoring.SequenceRuleQuery`
	`osid.ordering.PriceQuery`
	`osid.authorization.FunctionQuery`
	`osid.OsidEnablerQuery`
	`osid.OsidConstrainerQuery`
	`osid.OsidProcessorQuery`
	`osid.resource.demographic.DemographicQuery`
	`osid.checklist.mason.TodoProducerQuery`
	`osid.rules.check.AgendaQuery`
	`osid.rules.check.CheckQuery`
	`osid.course.requisite.RequisiteQuery`
	`osid.course.requisite.CourseRequirementQuery`
	`osid.calendaring.RecurringEventQuery`
	`osid.calendaring.SupersedingEventQuery`
	`osid.calendaring.OffsetEventQuery`
	`osid.configuration.ParameterQuery`
	`osid.inquiry.InquiryQuery`
	`osid.workflow.StepQuery`
	`osid.rules.RuleQuery`
	`osid.mapping.path.SpeedZoneQuery`
	`osid.mapping.path.SignalQuery`
	`osid.control.InputQuery`
	`osid.control.TriggerQuery`
	`osid.control.ActionQuery`
Description	This is the query interface for searching rules. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuleId
Description	Match the `Id` of the rule.
Parameters	`osid.id.Id`	`ruleId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`ruleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuleIdTerms
Description	Clears all rule `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuleQuery
Description	Tests if a `RuleQuery` for the rule is available.
Return	`boolean`		`true` if a rule query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuleQuery
Description	Gets the query for the rule. Each retrieval performs a boolean `OR`.
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Return	`osid.rules.RuleQuery`		the rule query
Errors	UNIMPLEMENTED		`supportsRuleQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuleQuery()` is `true`.
Method	matchAnyRule
Description	Match any associated rule.
Parameters	`boolean`	`match`	`true` to match any rule, `false` to match no rules
Compliance	`mandatory`		This method must be implemented.
Method	clearRuleTerms
Description	Clears all rule terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchConditionRecordType
Description	Matches a condition record type.
Parameters	`osid.type.Type`	`conditionRecordType`	a condition record `Type`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`conditionRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyConditionRecordType
Description	Matches rules with any condition record type.
Parameters	`boolean`	`match`	`true` to match rules with any condition record type, `false` to match rules with no condition record type
Compliance	`mandatory`		This method must be implemented.
Method	clearConditionRecordTypeTerms
Description	Clears the condition record `Type` query terms.
Compliance	`mandatory`		This method must be implemented.