OSID - osid.calendaring.RecurringEventQuery Service Interface Definition

Interface	osid.calendaring.RecurringEventQuery
Implements	`osid.OsidRuleQuery`
Implements	`osid.OsidContainableQuery`
Description	This is the query for searching recurring events. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR.`
Method	matchScheduleId
Description	Sets the schedule `Id` for this query for matching schedules.
Parameters	`osid.id.Id`	`scheduleId`	a schedule `Id`
Parameters	`boolean`	`match`	`true` 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 the schedule `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsScheduleQuery
Description	Tests if a `ScheduleQuery` is available for querying schedules.
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 a schedule. Multiple retrievals produce a nested `OR` term.
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	Matches a recurring event that has any schedule assigned.
Parameters	`boolean`	`match`	`true` to match recurring events with any schedules, `false` to match recurring events with no schedules
Compliance	`mandatory`		This method must be implemented.
Method	clearScheduleTerms
Description	Clears the schedule terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSupersedingEventId
Description	Sets the superseding event `Id` for this query.
Parameters	`osid.id.Id`	`supersedingEventId`	a 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	clearSupersedingEventIdTerms
Description	Clears the superseding event `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSupersedingEventQuery
Description	Tests if a `SupersedingEventQuery` is available for querying superseding events.
Return	`boolean`		`true` if a superseding event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventQuery
Description	Gets the query for a superseding event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.SupersedingEventQuery`		the superseding event query
Errors	UNIMPLEMENTED		`supportsSupersedingEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSupersedingEventQuery()` is `true.`
Method	matchAnySupersedingEvent
Description	Matches a recurring event that has any superseding event assigned.
Parameters	`boolean`	`match`	`true` to match recurring events with any superseding events, `false` to match events with no superseding events
Compliance	`mandatory`		This method must be implemented.
Method	clearSupersedingEventTerms
Description	Clears the superseding event terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSpecificMeetingTime
Description	Matches recurring events with specific dates between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start date
	`osid.calendaring.DateTime`	`end`	end date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is less than `start`
Errors	NULL_ARGUMENT		`start` or `end` is `zero`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySpecificMeetingTime
Description	Matches a recurring event that has any specific date assigned.
Parameters	`boolean`	`match`	`true` to match recurring events with any specific date, `false` to match recurring events with no specific date
Compliance	`mandatory`		This method must be implemented.
Method	clearSpecificMeetingTimeTerms
Description	Clears the blackout terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEventId
Description	Sets the composed event `Id` for this query.
Parameters	`osid.id.Id`	`eventId`	an event `Id`
Parameters	`boolean`	`match`	`true` 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 the event `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEventQuery
Description	Tests if an `EventQuery` is available for querying composed events.
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 an event. Multiple retrievals produce a nested `OR` term.
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	Matches a recurring event that has any composed event assigned.
Parameters	`boolean`	`match`	`true` to match recurring events with any composed events, `false` to match events with no composed events
Compliance	`mandatory`		This method must be implemented.
Method	clearEventTerms
Description	Clears the event terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBlackout
Description	Matches a blackout that contains the given date time.
Parameters	`osid.calendaring.DateTime`	`datetime`	a datetime
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`datetime` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyBlackout
Description	Matches a recurring event that has any blackout assigned.
Parameters	`boolean`	`match`	`true` to match recurring events with any blackout, `false` to match recurring events with no blackout
Compliance	`mandatory`		This method must be implemented.
Method	clearBlackoutTerms
Description	Clears the blackout terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBlackoutInclusive
Description	Matches recurring events with blackouts between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start date
	`osid.calendaring.DateTime`	`end`	end date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is less than `start`
Errors	NULL_ARGUMENT		`start` or `end` is `zero`
Compliance	`mandatory`		This method must be implemented.
Method	clearBlackoutInclusiveTerms
Description	Clears the blackout terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSponsorId
Description	Sets the sponsor `Id` for this query.
Parameters	`osid.id.Id`	`sponsorId`	a sponsor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`sponsorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSponsorIdTerms
Description	Clears the sponsor `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSponsorQuery
Description	Tests if a `LocationQuery` is available for querying sponsors.
Return	`boolean`		`true` if a sponsor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSponsorQuery
Description	Gets the query for a sponsor. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the sponsor query
Errors	UNIMPLEMENTED		`supportsSponsorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSponsorQuery()` is `true.`
Method	clearSponsorTerms
Description	Clears the sponsor terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCalendarId
Description	Sets the calendar `Id` for this query.
Parameters	`osid.id.Id`	`calendarId`	a 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` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCalendarQuery
Description	Tests if a `CalendarQuery` is available for querying calendars.
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 terms.
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventQueryRecord
Description	Gets the recurring event query recod corresponding to the given `RecurringEvent` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`recurringEventRecordType`	a recurring event query record type
Return	`osid.calendaring.records.RecurringEventQueryRecord`		the recurring event query record
Errors	NULL_ARGUMENT		`recurringEventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(recurringEventRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.