OSID - osid.calendaring.RecurringEventSearchSession Service Interface Definition

Interface	osid.calendaring.RecurringEventSearchSession
Implements	`osid.calendaring.RecurringEventQuerySession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
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 an 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`.
Method	getRecurringEventSearch
Description	Gets a recurring event search.
Return	`osid.calendaring.RecurringEventSearch`		the recurring event search
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventSearchOrder
Description	Gets a recurring event search order. The `RecurringEventSearchOrder` is supplied to a `RecurringEventSearch` to specify the ordering of results.
Return	`osid.calendaring.RecurringEventSearchOrder`		the recurring event search order
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.RecurringEventQuery`	`recurringEventQuery`	the recurring event search query
Parameters	`osid.calendaring.RecurringEventSearch`	`recurringEventSearch`	the recurring event search
Return	`osid.calendaring.RecurringEventSearchResults`		the recurring event search results
Errors	NULL_ARGUMENT		`recurringEventQuery` or `recurringEventSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`recurringEventSearch` or `recurringEventQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventQueryFromInspector
Description	Gets a recurring event query from an inspector. The inspector is available from a `RecurringEventSearchResults`.
Parameters	`osid.calendaring.RecurringEventQueryInspector`	`recurringEventQueryInspector`	a recurring event query inspector
Return	`osid.calendaring.RecurringEventQuery`		the recurring event query
Errors	NULL_ARGUMENT		`recurringEventQueryInspector` is `null`
Errors	UNSUPPORTED		`recurringEventQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.