OSID - osid.calendaring.SupersedingEventSearchSession Service Interface Definition

Interface	osid.calendaring.SupersedingEventSearchSession
Implements	`osid.calendaring.SupersedingEventQuerySession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session provides methods for searching `SupersedingEvent` objects. The search query is constructed using the `SupersedingEventQuery`. The superseding event record `Type` also specifies the record for the superseding event query. `getSupersedingEventsByQuery()` is the basic search method and returns a list of `SupersedingEvents`. A more advanced search may be performed with `getSupersedingEventsBySearch()`. It accepts a `SupersedingEventSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getSupersedingEventsBySearch()` returns a `SupersedingEventSearchResults` that can be used to access the resulting `SupersedingEventList` or be used to perform a search within the result set through `SupersedingEventSearch`. This session defines views that offer differing behaviors for searching. federated calendar view: searches include superseding events in calendars of which this calendar is an ancestor in the calendar hierarchy isolated calendar view: searches are restricted to superseding events in this calendar Superseding events may have a query record indicated by their respective record types. The query record is accessed via the `SupersedingEventQuery`.
Method	getSupersedingEventSearch
Description	Gets a superseding event search.
Return	`osid.calendaring.SupersedingEventSearch`		the superseding event search
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventSearchOrder
Description	Gets a superseding event search order. The `SupersedingEventSearchOrder` is supplied to a `SupersedingEventSearch` to specify the ordering of results.
Return	`osid.calendaring.SupersedingEventSearchOrder`		the superseding event search order
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.SupersedingEventQuery`	`supersedingEventQuery`	the superseding search query
Parameters	`osid.calendaring.SupersedingEventSearch`	`supersedingEventSearch`	the superseding search
Return	`osid.calendaring.SupersedingEventSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`supersedingEventQuery` or `supersedingEventSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`supersedingEventQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventQueryFromInspector
Description	Gets a superseding event query from an inspector. The inspector is available from a `SupersedingEventSearchResults`.
Parameters	`osid.calendaring.SupersedingEventQueryInspector`	`supersedingEventQueryInspector`	a superseding event query inspector
Return	`osid.calendaring.SupersedingEventQuery`		the superseding event query
Errors	NULL_ARGUMENT		`supersedingEventQueryInspector` is `null`
Errors	UNSUPPORTED		`supersedingEventQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.