OSID Logo
OSID Specifications
calendaring rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.rules.SupersedingEventEnablerSearchSession
Implementsosid.calendaring.rules.SupersedingEventEnablerQuerySession
Description

This session provides methods for searching among SupersedingEventEnabler objects. The search query is constructed using the SupersedingEventEnablerQuery.

getSupersedingEventEnablersByQuery() is the basic search method and returns a list of SupersedingEventEnablers. A more advanced search may be performed with getSupersedingEventEnablersBySearch(). It accepts a SupersedingEventEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as calendaring. getSupersedingEventEnablersBySearch() returns a SupersedingEventEnablerSearchResults that can be used to access the resulting SupersedingEventEnablerList or be used to perform a search within the result set through SupersedingEventEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

SupersedingEventEnablers may have a query record indicated by their respective record types. The query record is accessed via the SupersedingEventEnablerQuery.

MethodgetSupersedingEventEnablerSearch
Description

Gets a superseding event enabler search.

Returnosid.calendaring.rules.SupersedingEventEnablerSearchthe superseding event enabler search
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventEnablerSearchOrder
Description

Gets a superseding event enabler search order. The SupersedingEventEnablerSearchOrder is supplied to a SupersedingEventEnablerSearch to specify the ordering of results.

Returnosid.calendaring.rules.SupersedingEventEnablerSearchOrderthe superseding event enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventEnablersBySearch
Description

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

Parametersosid.calendaring.rules.SupersedingEventEnablerQuerysupersedingEventEnablerQuerythe superseding event enabler query
osid.calendaring.rules.SupersedingEventEnablerSearchsupersedingEventEnablerSearchthe superseding event enabler search
Returnosid.calendaring.rules.SupersedingEventEnablerSearchResultsthe superseding event search results
ErrorsNULL_ARGUMENT supersedingEventEnablerQuery or supersedingEventEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED supersedingEventEnablerQuery or supersedingEventEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventEnablerQueryFromInspector
Description

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

Parametersosid.calendaring.rules.SupersedingEventEnablerQueryInspectorsupersedingEventEnablerQueryInspectora superseding event enabler query inspector
Returnosid.calendaring.rules.SupersedingEventEnablerQuerythe superseding event enabler query
ErrorsNULL_ARGUMENT supersedingEventEnablerQueryInspector is null
UNSUPPORTED supersedingEventEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.