OSID - osid.OsidEnablerQuery Service Interface Definition

Interface	osid.OsidEnablerQuery
Implements	`osid.OsidRuleQuery`
Implements	`osid.OsidTemporalQuery`
Description	This is the query interface for searching enablers. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchScheduleId
Description	Match the `Id` of an associated schedule.
Parameters	`osid.id.Id`	`scheduleId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`scheduleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearScheduleIdTerms
Description	Clears all schedule `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsScheduleQuery
Description	Tests if a `ScheduleQuery` for the rule is available.
Return	`boolean`		`true` if a schedule query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleQuery
Description	Gets the query for the schedule. Each retrieval performs a boolean `OR.`
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Return	`osid.calendaring.ScheduleQuery`		the schedule query
Errors	UNIMPLEMENTED		`supportsScheduleQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsScheduleQuery()` is `true.`
Method	matchAnySchedule
Description	Match any associated schedule.
Parameters	`boolean`	`match`	`true` to match any schedule, `false` to match no schedules
Compliance	`mandatory`		This method must be implemented.
Method	clearScheduleTerms
Description	Clears all schedule terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEventId
Description	Match the `Id` of an associated event.
Parameters	`osid.id.Id`	`eventId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`eventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEventIdTerms
Description	Clears all event `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEventQuery
Description	Tests if a `EventQuery` for the rule is available.
Return	`boolean`		`true` if an event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEventQuery
Description	Gets the query for the event. Each retrieval performs a boolean `OR.`
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Return	`osid.calendaring.EventQuery`		the event query
Errors	UNIMPLEMENTED		`supportsEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEventQuery()` is `true.`
Method	matchAnyEvent
Description	Match any associated event.
Parameters	`boolean`	`match`	`true` to match any event, `false` to match no events
Compliance	`mandatory`		This method must be implemented.
Method	clearEventTerms
Description	Clears all recurirng event terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCyclicEventId
Description	Sets the cyclic event `Id` for this query.
Parameters	`osid.id.Id`	`cyclicEventId`	the cyclic event `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`cyclicEventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCyclicEventIdTerms
Description	Clears the cyclic event `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventQuery
Description	Tests if a `CyclicEventQuery` is available.
Return	`boolean`		`true` if a cyclic event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventQuery
Description	Gets the query for a cyclic event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.cycle.CyclicEventQuery`		the cyclic event query
Errors	UNIMPLEMENTED		`supportsCyclicEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCyclicEventQuery()` is `true.`
Method	matchAnyCyclicEvent
Description	Matches any enabler with a cyclic event.
Parameters	`boolean`	`match`	`true` to match any enablers with a cyclic event, `false` to match enablers with no cyclic events
Compliance	`mandatory`		This method must be implemented.
Method	clearCyclicEventTerms
Description	Clears the cyclic event query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDemographicId
Description	Match the `Id` of the demographic resource.
Parameters	`osid.id.Id`	`resourceId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDemographicIdTerms
Description	Clears all resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDemographicQuery
Description	Tests if a `ResourceQuery` for the demographic is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicQuery
Description	Gets the query for the resource. Each retrieval performs a boolean `OR.`
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceQuery()` is `true.`
Method	matchAnyDemographic
Description	Match any associated resource.
Parameters	`boolean`	`match`	`true` to match any demographic, `false` to match no rules
Compliance	`mandatory`		This method must be implemented.
Method	clearDemographicTerms
Description	Clears all demographic terms.
Compliance	`mandatory`		This method must be implemented.