OSID - osid.calendaring.rules.SupersedingEventEnablerQuery Service Interface Definition

Interface	osid.calendaring.rules.SupersedingEventEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.calendaring.rules.SupersedingEventEnablerQuerySession`
	`osid.calendaring.rules.SupersedingEventEnablerSearchSession`
	`osid.calendaring.rules.SupersedingEventEnablerSmartCalendarSession`
Description	This is the query for searching superseding event enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledSupersedingEventId
Description	Matches enablers mapped to the superseding event.
Parameters	`osid.id.Id`	`supersedingEventId`	the superseding event `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`supersedingEventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledSupersedingEventIdTerms
Description	Clears the superseding event `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledSupersedingEventQuery
Description	Tests if an `SupersedingEventQuery` is available.
Return	`boolean`		`true` if a superseding event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledSupersedingEventQuery
Description	Gets the query for a supsreding event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.SupersedingEventQuery`		the superseding event query
Errors	UNIMPLEMENTED		`supportsRuledSupersedingEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledSupersedingEventQuery()` is `true`.
Method	matchAnyRuledSupersedingEvent
Description	Matches enablers mapped to any supsreding event.
Parameters	`boolean`	`match`	`true` for enablers mapped to any supsreding event, `false` to match enablers mapped to no supsreding events
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledSupersedingEventTerms
Description	Clears the calendar query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCalendarId
Description	Matches enablers mapped to the calendar.
Parameters	`osid.id.Id`	`calendarId`	the calendar `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`calendarId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCalendarIdTerms
Description	Clears the calendar `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCalendarQuery
Description	Tests if a `CalendarQuery` is available.
Return	`boolean`		`true` if a calendar query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarQuery
Description	Gets the query for a calendar. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.CalendarQuery`		the calendar query
Errors	UNIMPLEMENTED		`supportsCalendarQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCalendarQuery()` is `true`.
Method	clearCalendarTerms
Description	Clears the calendar query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventEnablerQueryRecord
Description	Gets the superseding event enabler query record corresponding to the given `SupersedingEventEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`supersedingEventEnablerRecordType`	a superseding event enabler record type
Return	`osid.calendaring.rules.records.SupersedingEventEnablerQueryRecord`		the superseding event enabler query record
Errors	NULL_ARGUMENT		`supersedingEventEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(supersedingEventEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.