OSID Logo
OSID Specifications
calendaring cycle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.CyclicEventSearchSession
Implementsosid.calendaring.cycle.CyclicEventQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetCyclicEventSearch
Description

Gets a cyclic event search.

Returnosid.calendaring.cycle.CyclicEventSearchthe cyclic event search
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventSearchOrder
Description

Gets a cyclic event search order. The CyclicEventSearchOrder is supplied to a CyclicEventSearch to specify the ordering of results.

Returnosid.calendaring.cycle.CyclicEventSearchOrderthe cyclic event search order
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventsBySearch
Description

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

Parametersosid.calendaring.cycle.CyclicEventQuerycyclicEventQuerythe cyclic event search query
osid.calendaring.cycle.CyclicEventSearchcyclicEventSearchthe cyclic event search
Returnosid.calendaring.cycle.CyclicEventSearchResultsthe cyclic event search results
ErrorsNULL_ARGUMENT cyclicEventQuery or cyclicEventSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED cyclicEventSearch or cyclicEventQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventQueryFromInspector
Description

Gets a cyclic event query from an inspector. The inspector is available from a CyclicEventSearchResults.

Parametersosid.calendaring.cycle.CyclicEventQueryInspectorcyclicEventQueryInspectora cyclic event query inspector
Returnosid.calendaring.cycle.CyclicEventQuerythe cyclic event query
ErrorsNULL_ARGUMENT cyclicEventQueryInspector is null
UNSUPPORTED cyclicEventQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.