OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.RecurringEventSearchSession
Implementsosid.calendaring.RecurringEventQuerySession
Description

This session provides methods for searching RecurringEvent objects. The search query is constructed using the RecurringEventQuery. The recurring event record Type also specifies the record for the recurring event query.

getRecurringEventsByQuery() is the basic search method and returns a list of RecurringEvents. A more advanced search may be performed with geRecurringEventsBySearch(). It accepts a RecurringEventSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRecurringEventsBySearch() returns a RecurringEventSearchResults that can be used to access the resulting RecurringEventList or be used to perform a search within the result set through RecurringEventSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetRecurringEventSearch
Description

Gets a recurring event search.

Returnosid.calendaring.RecurringEventSearchthe recurring event search
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventSearchOrder
Description

Gets a recurring event search order. The RecurringEventSearchOrder is supplied to a RecurringEventSearch to specify the ordering of results.

Returnosid.calendaring.RecurringEventSearchOrderthe recurring event search order
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventsBySearch
Description

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

Parametersosid.calendaring.RecurringEventQueryrecurringEventQuerythe recurring event search query
osid.calendaring.RecurringEventSearchrecurringEventSearchthe recurring event search
Returnosid.calendaring.RecurringEventSearchResultsthe recurring event search results
ErrorsNULL_ARGUMENT recurringEventQuery or recurringEventSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED recurringEventSearch or recurringEventQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventQueryFromInspector
Description

Gets a recurring event query from an inspector. The inspector is available from a RecurringEventSearchResults.

Parametersosid.calendaring.RecurringEventQueryInspectorrecurringEventQueryInspectora recurring event query inspector
Returnosid.calendaring.RecurringEventQuerythe recurring event query
ErrorsNULL_ARGUMENT recurringEventQueryInspector is null
UNSUPPORTED recurringEventQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.