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

Interface	osid.calendaring.rules.RecurringEventEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.calendaring.rules.RecurringEventEnablerQuerySession`
	`osid.calendaring.rules.RecurringEventEnablerSearchSession`
	`osid.calendaring.rules.RecurringEventEnablerSmartCalendarSession`
Description	This is the query for searching recurring event enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledRecurringEventId
Description	Matches enablers mapped to the recurring event.
Parameters	`osid.id.Id`	`recurringEventId`	the recurring event `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`recurringEventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledRecurringEventIdTerms
Description	Clears the recurring event `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledRecurringEventQuery
Description	Tests if a `RecurringEventQuery` is available.
Return	`boolean`		`true` if a recurring event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledRecurringEventQuery
Description	Gets the query for a recurring event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.RecurringEventQuery`		the recurring event query
Errors	UNIMPLEMENTED		`supportsRuledRecurringEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledRecurringEventQuery()` is `true`.
Method	matchAnyRuledRecurringEvent
Description	Matches enablers mapped to any recurring event.
Parameters	`boolean`	`match`	`true` for enablers mapped to any recurring event, `false` to match enablers mapped to no recurring events
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledRecurringEventTerms
Description	Clears the recurring event 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	getRecurringEventEnablerQueryRecord
Description	Gets the recurring event enabler query record corresponding to the given `RecurringEventEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`recurringEventEnablerRecordType`	a recurring event enabler record type
Return	`osid.calendaring.rules.records.RecurringEventEnablerQueryRecord`		the recurring event enabler query record
Errors	NULL_ARGUMENT		`recurringEventEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(recurringEventEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.