OSID - osid.calendaring.SupersedingEventQuery Service Interface Definition

Interface	osid.calendaring.SupersedingEventQuery
Implements	`osid.OsidRuleQuery`
Used By	`osid.calendaring.EventQuery`
	`osid.calendaring.RecurringEventQuery`
	`osid.calendaring.SupersedingEventQuerySession`
	`osid.calendaring.SupersedingEventSearchSession`
	`osid.calendaring.SupersedingEventSmartCalendarSession`
	`osid.calendaring.rules.SupersedingEventEnablerQuery`
Description	This is the query for searching superseding events. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR`.
Method	matchSupersededEventId
Description	Sets the event `Id` for this query for matching attached events.
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	clearSupersededEventIdTerms
Description	Clears the event `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSupersededEventQuery
Description	Tests if an `EventQuery` is available for querying attached events.
Return	`boolean`		`true` if an event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSupersededEventQuery
Description	Gets the query for an attached event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.EventQuery`		the event query
Errors	UNIMPLEMENTED		`supportsSupersededEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSupersededEventQuery()` is `true`.
Method	clearSupersededEventTerms
Description	Clears the event 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.
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.EventQuery`		the superseding event query
Errors	UNIMPLEMENTED		`supportsSupersedingEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSupersedingEventQuery()` is `true`.
Method	clearSupersedingEventTerms
Description	Clears the superseding event terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSupersededDate
Description	Matches superseding events that supersede within the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	start date
	`osid.calendaring.DateTime`	`to`	end date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySupersededDate
Description	Matches a superseding event that has any superseded date.
Parameters	`boolean`	`match`	`true` to match superseding events with any superseded date, false to match superseding events with no superseded date
Compliance	`mandatory`		This method must be implemented.
Method	clearSupersededDateTerms
Description	Clears the superseded date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSupersededEventPosition
Description	Matches superseding events that supersede within the denormalized event positions inclusive.
Parameters	`integer`	`from`	start position
	`integer`	`to`	end position
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		the absolute value of `from` is greater than `to`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySupersededEventPosition
Description	Matches a superseding event that has any superseded position.
Parameters	`boolean`	`match`	`true` to match superseding events with any superseded event position, false to match superseding events with no superseded event position
Compliance	`mandatory`		This method must be implemented.
Method	clearSupersededEventPositionTerms
Description	Clears the superseded position 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	getSupersedingEventQueryRecord
Description	Gets the superseding event query record corresponding to the given `SupersedingEvent` record `Type`. Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`supersedingEventRecordType`	a superseding event query record type
Return	`osid.calendaring.records.SupersedingEventQueryRecord`		the superseding event query record
Errors	NULL_ARGUMENT		`supersedingEventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(supersedingEventRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.