OSID - osid.calendaring.EventQuery Service Interface Definition

Interface	osid.calendaring.EventQuery
Implements	`osid.OsidObjectQuery`
	`osid.OsidTemporalQuery`
	`osid.OsidContainableQuery`
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	matchImplicit
Description	Matches an event that is implicitly generated.
Parameters	`boolean`	`match`	`true` to match events implicitly generated, `false` to match events explicitly defined
Compliance	`mandatory`		This method must be implemented.
Method	clearImplicitTerms
Description	Clears the implcit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDuration
Description	Matches the event duration between the given range inclusive.
Parameters	`osid.calendaring.Duration`	`low`	low duration range
	`osid.calendaring.Duration`	`high`	high duration range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`high` is less than `low`
Errors	NULL_ARGUMENT		`high` or `low` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDuration
Description	Matches an event that has any duration.
Parameters	`boolean`	`match`	`true` to match events with any duration, `false` to match events with no start time
Compliance	`mandatory`		This method must be implemented.
Method	clearDurationTerms
Description	Clears the duration terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRecurringEventId
Description	Matches events that related to the recurring event.
Parameters	`osid.id.Id`	`recurringEventId`	an `Id` for a recurring event
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	clearRecurringEventIdTerms
Description	Clears the recurring event terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRecurringEventQuery
Description	Tests if a `RecurringEventQuery` is available for querying recurring events.
Return	`boolean`		`true` if a recurring event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventQuery
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		`supportsRecurringEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRecurringEventQuery()` is `true.`
Method	matchAnyRecurringEvent
Description	Matches an event that is part of any recurring event.
Parameters	`boolean`	`match`	`true` to match events part of any recurring event, `false` to match only standalone events
Compliance	`mandatory`		This method must be implemented.
Method	clearRecurringEventTerms
Description	Clears the recurring event terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSupersedingEventId
Description	Matches events that relate to the superseding event.
Parameters	`osid.id.Id`	`supersedingEventId`	an `Id` for a superseding event
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearSupersedingEventIdTerms
Description	Clears the superseding events type terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSupersedingEventQuery
Description	Tests if a `SupersedingEventQuery` is available for querying offset 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 any superseding event.
Parameters	`boolean`	`match`	`true` to match any superseding events, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearSupersedingEventTerms
Description	Clears the superseding event terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOffsetEventId
Description	Matches events that relates to the offset event.
Parameters	`osid.id.Id`	`offsetEventId`	an `Id` for an offset event
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearOffsetEventIdTerms
Description	Clears the recurring events type terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOffsetEventQuery
Description	Tests if an `OffsetEventQuery` is available for querying offset events.
Return	`boolean`		`true` if an offset event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventQuery
Description	Gets the query for an offset event. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.OffsetEventQuery`		the offset event query
Errors	UNIMPLEMENTED		`supportsOffsetEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOffsetEventQuery()` is `true.`
Method	matchAnyOffsetEvent
Description	Matches any offset event.
Parameters	`boolean`	`match`	`true` to match any offset events, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearOffsetEventTerms
Description	Clears the offset event 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	matchCoordinate
Description	Matches events whose locations contain the given coordinate.
Parameters	`osid.mapping.Coordinate`	`coordinate`	a coordinate
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`coordinate` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCoordinateTerms
Description	Clears the cooordinate terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSpatialUnit
Description	Matches events whose locations fall within the given spatial unit.
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	a spatial unit
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`spatialUnit` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSpatialUnitTerms
Description	Clears the spatial unit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCommitmentId
Description	Sets the commitment `Id` for this query.
Parameters	`osid.id.Id`	`commitmentId`	a commitment `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`commitmentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCommitmentIdTerms
Description	Clears the commitment `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommitmentQuery
Description	Tests if a `CommitmentQuery` is available for querying recurring event terms.
Return	`boolean`		`true` if a commitment query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentQuery
Description	Gets the query for a commitment. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.CommitmentQuery`		the commitment query
Errors	UNIMPLEMENTED		`supportsCommitmentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommitmentQuery()` is `true.`
Method	matchAnyCommitment
Description	Matches an event that has any commitment.
Parameters	`boolean`	`match`	`true` to match events with any commitment, `false` to match events with no commitments
Compliance	`mandatory`		This method must be implemented.
Method	clearCommitmentTerms
Description	Clears the commitment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchContainingEventId
Description	Sets the event `Id` for this query to match events that have the specified event as an ancestor.
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	clearContainingEventIdTerms
Description	Clears the containing event `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsContainingEventQuery
Description	Tests if a containing event query is available.
Return	`boolean`		`true` if a containing event query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getContainingEventQuery
Description	Gets the query for a containing event.
Return	`osid.calendaring.EventQuery`		the containing event query
Errors	UNIMPLEMENTED		`supportsContainingEventQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContainingEventQuery()` is `true.`
Method	matchAnyContainingEvent
Description	Matches events with any ancestor event.
Parameters	`boolean`	`match`	`true` to match events with any ancestor event, `false` to match events with no ancestor events
Compliance	`mandatory`		This method must be implemented.
Method	clearContainingEventTerms
Description	Clears the containing event 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	getEventQueryRecord
Description	Gets the event query record corresponding to the given `Event` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`eventRecordType`	an event query record type
Return	`osid.calendaring.records.EventQueryRecord`		the event query record
Errors	NULL_ARGUMENT		`eventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(eventRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.