OSID - osid.calendaring.OffsetEventQuery Service Interface Definition

Interface	osid.calendaring.OffsetEventQuery
Implements	`osid.OsidRuleQuery`
Used By	`osid.calendaring.EventQuery`
	`osid.calendaring.OffsetEventQuerySession`
	`osid.calendaring.OffsetEventSearchSession`
	`osid.calendaring.OffsetEventSmartCalendarSession`
	`osid.calendaring.rules.OffsetEventEnablerQuery`
Description	This is the query for searching events. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR`.
Method	matchFixedStartTime
Description	Matches a fixed start time between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	the start of the range
	`osid.calendaring.DateTime`	`to`	the end of the range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`to` is less than `from`
Errors	NULL_ARGUMENT		`from` or `to` `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyFixedStartTime
Description	Matches events with fixed start times.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearFixedStartTimeTerms
Description	Clears the fixed start time terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStartReferenceEventId
Description	Sets the start reference 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	clearStartReferenceEventIdTerms
Description	Clears the start reference event `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStartReferenceEventQuery
Description	Tests if an `EventQuery` is available for querying start reference event terms.
Return	`boolean`		`true` if an event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStartReferenceEventQuery
Description	Gets the query for the start reference event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.EventQuery`		the event query
Errors	UNIMPLEMENTED		`supportsStartReferenceEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStartReferenceEventQuery()` is `true`.
Method	matchAnyStartReferenceEvent
Description	Matches offset events with any starting reference event.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearStartReferenceEventTerms
Description	Clears the start reference event terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFixedStartOffset
Description	Matches a fixed offset amount between the given range inclusive.
Parameters	`osid.calendaring.Duration`	`from`	the start of the range
	`osid.calendaring.Duration`	`to`	the end of the range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`to` is less than `from`
Errors	NULL_ARGUMENT		`from` or `to` `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyFixedStartOffset
Description	Matches fixed offset events.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearFixedStartOffsetTerms
Description	Clears the fixed offset terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRelativeWeekdayStartOffset
Description	Matches a relative weekday offset amount between the given range inclusive.
Parameters	`integer`	`low`	the start of the range
	`integer`	`high`	the end of the range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearRelativeWeekdayStartOffsetTerms
Description	Clears the relative weekday offset terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRelativeStartWeekday
Description	Matches a relative weekday.
Parameters	`cardinal`	`weekday`	the weekday
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyRelativeStartWeekday
Description	Matches relative weekday offset events.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearRelativeStartWeekdayTerms
Description	Clears the relative weekday terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFixedDuration
Description	Matches a fixed duration between the given range inclusive.
Parameters	`osid.calendaring.Duration`	`low`	the start of the range
	`osid.calendaring.Duration`	`high`	the end of the range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearFixedDurationTerms
Description	Clears the fixed duration offset terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEndReferenceEventId
Description	Sets the end reference 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	clearEndReferenceEventIdTerms
Description	Clears the end reference event `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndReferenceEventQuery
Description	Tests if an `EventQuery` is available for querying end reference event terms.
Return	`boolean`		`true` if an event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEndReferenceEventQuery
Description	Gets the query for the end reference event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.EventQuery`		the event query
Errors	UNIMPLEMENTED		`supportsEventReferenceEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEndReferenceEventQuery()` is `true`.
Method	matchAnyEndReferenceEvent
Description	Matches any end reference event events.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearEndReferenceEventTerms
Description	Clears the end reference event terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFixedEndOffset
Description	Matches a fixed offset amount between the given range inclusive.
Parameters	`osid.calendaring.Duration`	`from`	the start of the range
	`osid.calendaring.Duration`	`to`	the end of the range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`to` is less than `from`
Errors	NULL_ARGUMENT		`from` or `to` `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyFixedEndOffset
Description	Matches fixed offset events.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearFixedEndOffsetTerms
Description	Clears the fixed offset terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRelativeWeekdayEndOffset
Description	Matches a relative weekday offset amount between the given range inclusive.
Parameters	`integer`	`low`	the start of the range
	`integer`	`high`	the end of the range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearRelativeWeekdayEndOffsetTerms
Description	Clears the relative weekday offset terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRelativeEndWeekday
Description	Matches a relative weekday.
Parameters	`cardinal`	`weekday`	the weekday
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyRelativeEndWeekday
Description	Matches relative weekday offset events.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearRelativeEndWeekdayTerms
Description	Clears the relative weekday terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLocationDescription
Description	Matches the location description string.
Parameters	`string`	`location`	location string
	`osid.type.Type`	`stringMatchType`	string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`location` is not of `stringMatchType`
	NULL_ARGUMENT		`location` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyLocationDescription
Description	Matches an event that has any location description assigned.
Parameters	`boolean`	`match`	`true` to match events with any location description, `false` to match events with no location description
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationDescriptionTerms
Description	Clears the location description terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLocationId
Description	Sets the location `Id` for this query.
Parameters	`osid.id.Id`	`locationId`	a location `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`locationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationIdTerms
Description	Clears the location `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationQuery
Description	Tests if a `LocationQuery` is available for querying locations.
Return	`boolean`		`true` if a location query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLocationQuery
Description	Gets the query for a location. Multiple retrievals produce a nested `OR` term.
Return	`osid.mapping.LocationQuery`		the location query
Errors	UNIMPLEMENTED		`supportsLocationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationQuery()` is `true`.
Method	matchAnyLocation
Description	Matches an event that has any location assigned.
Parameters	`boolean`	`match`	`true` to match events with any location, `false` to match events with no location
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationTerms
Description	Clears the location 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	getOffsetEventQueryRecord
Description	Gets the offset event query record corresponding to the given `OffsetEvent` record `Type`. Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`offsetEventRecordType`	an offset event query record type
Return	`osid.calendaring.records.OffsetEventQueryRecord`		the offset event query record
Errors	NULL_ARGUMENT		`offsetEventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(offsetEventRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.