OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.EventSearchSession
Implementsosid.calendaring.EventQuerySession
Description

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

getEventsByQuery() is the basic search method and returns a list of Events. A more advanced search may be performed with getEventsBySearch(). It accepts an EventSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getEventsBySearch() returns an EventSearchResults that can be used to access the resulting EventList or be used to perform a search within the result set through EventSearch.

This session defines views that offer differing behaviors for searching.

  • federated calendar view: searches include events in calendars of which this calendar is a ancestor in the calendar hierarchy
  • isolated calendar view: searches are restricted to events in this calendar
  • denormalized event view: recurring events are expanded into a series of non-recurring events
  • normalized event view: a series of recurring events is represented by a single Event

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

MethodgetEventSearch
Description

Gets an event search.

Returnosid.calendaring.EventSearchthe event search
CompliancemandatoryThis method must be implemented.
MethodgetEventSearchOrder
Description

Gets an event search order. The EventSearchOrder is supplied to an EventSearch to specify the ordering of results.

Returnosid.calendaring.EventSearchOrderthe event search order
CompliancemandatoryThis method must be implemented.
MethodgetEventsBySearch
Description

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

Parametersosid.calendaring.EventQueryeventQuerythe event search query
osid.calendaring.EventSearcheventSearchthe event search
Returnosid.calendaring.EventSearchResultsthe event search results
ErrorsNULL_ARGUMENT eventQuery or eventSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED eventSearch or eventQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetEventQueryFromInspector
Description

Gets an event query from an inspector. The inspector is available from an EventSearchResults.

Parametersosid.calendaring.EventQueryInspectoreventQueryInspectoran event query inspector
Returnosid.calendaring.EventQuerythe event query
ErrorsNULL_ARGUMENT eventQueryInspector is null
UNSUPPORTED eventQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.