OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.SupersedingEventQuery
Implementsosid.OsidRuleQuery
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.

MethodmatchSupersededEventId
Description

Sets the event Id for this query for matching attached events.

Parametersosid.id.IdeventIdan event Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT eventId is null
CompliancemandatoryThis method must be implemented.
MethodclearSupersededEventIdTerms
Description

Clears the event Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSupersededEventQuery
Description

Tests if an EventQuery is available for querying attached events.

Returnboolean true if an event query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSupersededEventQuery
Description

Gets the query for an attached event. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.EventQuerythe event query
ErrorsUNIMPLEMENTED supportsSupersededEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsSupersededEventQuery() is true.
MethodclearSupersededEventTerms
Description

Clears the event terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSupersedingEventId
Description

Sets the superseding event Id for this query.

Parametersosid.id.IdsupersedingEventIda superseding event Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT supersedingEventId is null
CompliancemandatoryThis method must be implemented.
MethodclearSupersedingEventIdTerms
Description

Clears the superseding event Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSupersedingEventQuery
Description

Tests if a SupersedingEventQuery is available.

Returnboolean true if a superseding event query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventQuery
Description

Gets the query for a superseding event. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.EventQuerythe superseding event query
ErrorsUNIMPLEMENTED supportsSupersedingEventQuery() is false
ComplianceoptionalThis method must be implemented if supportsSupersedingEventQuery() is true.
MethodclearSupersedingEventTerms
Description

Clears the superseding event terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSupersededDate
Description

Matches superseding events that supersede within the given dates inclusive.

Parametersosid.calendaring.DateTimefromstart date
osid.calendaring.DateTimetoend date
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnySupersededDate
Description

Matches a superseding event that has any superseded date.

Parametersbooleanmatch true to match superseding events with any superseded date, false to match superseding events with no superseded date
CompliancemandatoryThis method must be implemented.
MethodclearSupersededDateTerms
Description

Clears the superseded date terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSupersededEventPosition
Description

Matches superseding events that supersede within the denormalized event positions inclusive.

Parametersintegerfromstart position
integertoend position
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENTthe absolute value of from is greater than to
CompliancemandatoryThis method must be implemented.
MethodmatchAnySupersededEventPosition
Description

Matches a superseding event that has any superseded position.

Parametersbooleanmatch true to match superseding events with any superseded event position, false to match superseding events with no superseded event position
CompliancemandatoryThis method must be implemented.
MethodclearSupersededEventPositionTerms
Description

Clears the superseded position terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCalendarId
Description

Sets the calendar Id for this query.

Parametersosid.id.IdcalendarIda calendar Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT calendarId is null
CompliancemandatoryThis method must be implemented.
MethodclearCalendarIdTerms
Description

Clears the calendar Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCalendarQuery
Description

Tests if a CalendarQuery is available for querying calendars.

Returnboolean true if a calendar query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCalendarQuery
Description

Gets the query for a calendar. Multiple retrievals produce a nested OR term.

Returnosid.calendaring.CalendarQuerythe calendar query
ErrorsUNIMPLEMENTED supportsCalendarQuery() is false
ComplianceoptionalThis method must be implemented if supportsCalendarQuery() is true.
MethodclearCalendarTerms
Description

Clears the calendar terms.

CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventQueryRecord
Description

Gets the superseding event query record corresponding to the given SupersedingEvent record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypesupersedingEventRecordTypea superseding event query record type
Returnosid.calendaring.records.SupersedingEventQueryRecordthe superseding event query record
ErrorsNULL_ARGUMENT supersedingEventRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(supersedingEventRecordType) is false
CompliancemandatoryThis method must be implemented.