OSID - osid.calendaring.EventSearchSession Service Interface Definition

Interface	osid.calendaring.EventSearchSession
Implements	`osid.calendaring.EventQuerySession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
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 an 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`.
Method	getEventSearch
Description	Gets an event search.
Return	`osid.calendaring.EventSearch`		the event search
Compliance	`mandatory`		This method must be implemented.
Method	getEventSearchOrder
Description	Gets an event search order. The `EventSearchOrder` is supplied to an `EventSearch` to specify the ordering of results.
Return	`osid.calendaring.EventSearchOrder`		the event search order
Compliance	`mandatory`		This method must be implemented.
Method	getEventsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.EventQuery`	`eventQuery`	the event search query
Parameters	`osid.calendaring.EventSearch`	`eventSearch`	the event search
Return	`osid.calendaring.EventSearchResults`		the event search results
Errors	NULL_ARGUMENT		`eventQuery` or `eventSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`eventSearch` or `eventQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getEventQueryFromInspector
Description	Gets an event query from an inspector. The inspector is available from an `EventSearchResults`.
Parameters	`osid.calendaring.EventQueryInspector`	`eventQueryInspector`	an event query inspector
Return	`osid.calendaring.EventQuery`		the event query
Errors	NULL_ARGUMENT		`eventQueryInspector` is `null`
Errors	UNSUPPORTED		`eventQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.