OSID - osid.calendaring.cycle.CyclicEventSearchSession Service Interface Definition

Interface	osid.calendaring.cycle.CyclicEventSearchSession
Implements	`osid.calendaring.cycle.CyclicEventQuerySession`
Used By	`osid.calendaring.cycle.CalendaringCycleManager`
Used By	`osid.calendaring.cycle.CalendaringCycleProxyManager`
Description	This session provides methods for searching `CyclicEvents`. 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 an 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`.
Method	getCyclicEventSearch
Description	Gets a cyclic event search.
Return	`osid.calendaring.cycle.CyclicEventSearch`		the cyclic event search
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventSearchOrder
Description	Gets a cyclic event search order. The `CyclicEventSearchOrder` is supplied to a `CyclicEventSearch` to specify the ordering of results.
Return	`osid.calendaring.cycle.CyclicEventSearchOrder`		the cyclic event search order
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.cycle.CyclicEventQuery`	`cyclicEventQuery`	the cyclic event search query
Parameters	`osid.calendaring.cycle.CyclicEventSearch`	`cyclicEventSearch`	the cyclic event search
Return	`osid.calendaring.cycle.CyclicEventSearchResults`		the cyclic event search results
Errors	NULL_ARGUMENT		`cyclicEventQuery` or `cyclicEventSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`cyclicEventSearch` or `cyclicEventQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventQueryFromInspector
Description	Gets a cyclic event query from an inspector. The inspector is available from a `CyclicEventSearchResults`.
Parameters	`osid.calendaring.cycle.CyclicEventQueryInspector`	`cyclicEventQueryInspector`	a cyclic event query inspector
Return	`osid.calendaring.cycle.CyclicEventQuery`		the cyclic event query
Errors	NULL_ARGUMENT		`cyclicEventQueryInspector` is `null`
Errors	UNSUPPORTED		`cyclicEventQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.