OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.SupersedingEventSearchSession
Implementsosid.calendaring.SupersedingEventQuerySession
Description

This session provides methods for searching SupersedingEvent objects. The search query is constructed using the SupersedingEventQuery. The superseding event record Type also specifies the record for the superseding event query.

getSupersedingEventsByQuery() is the basic search method and returns a list of SupersedingEvents. A more advanced search may be performed with getSupersedingEventsBySearch(). It accepts a SupersedingEventSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getSupersedingEventsBySearch() returns a SupersedingEventSearchResults that can be used to access the resulting SupersedingEventList or be used to perform a search within the result set through SupersedingEventSearch.

This session defines views that offer differing behaviors for searching.

  • federated calendar view: searches include superseding events in calendars of which this calendar is a ancestor in the calendar hierarchy
  • isolated calendar view: searches are restricted to superseding events in this calendar

Superseding events may have a query record indicated by their respective record types. The query record is accessed via the SupersedingEventQuery.

MethodgetSupersedingEventSearch
Description

Gets a superseding event search.

Returnosid.calendaring.SupersedingEventSearchthe superseding event search
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventSearchOrder
Description

Gets a superseding event search order. The SupersedingEventSearchOrder is supplied to a SupersedingEventSearch to specify the ordering of results.

Returnosid.calendaring.SupersedingEventSearchOrderthe superseding event search order
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.calendaring.SupersedingEventQuerysupersedingEventQuerythe superseding search query
osid.calendaring.SupersedingEventSearchsupersedingEventSearchthe superseding search
Returnosid.calendaring.SupersedingEventSearchResultsthe returned search results
ErrorsNULL_ARGUMENT supersedingEventQuery or supersedingEventSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED supersedingEventQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventQueryFromInspector
Description

Gets a superseding event query from an inspector. The inspector is available from a SupersedingEventSearchResults.

Parametersosid.calendaring.SupersedingEventQueryInspectorsupersedingEventQueryInspectora superseding event query inspector
Returnosid.calendaring.SupersedingEventQuerythe superseding event query
ErrorsNULL_ARGUMENT supersedingEventQueryInspector is null
UNSUPPORTED supersedingEventQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.