OSID - osid.calendaring.rules.SupersedingEventEnablerSearchSession Service Interface Definition

Interface	osid.calendaring.rules.SupersedingEventEnablerSearchSession
Implements	`osid.calendaring.rules.SupersedingEventEnablerQuerySession`
Used By	`osid.calendaring.rules.CalendaringRulesManager`
Used By	`osid.calendaring.rules.CalendaringRulesProxyManager`
Description	This session provides methods for searching among `SupersedingEventEnabler` objects. The search query is constructed using the `SupersedingEventEnablerQuery`. `getSupersedingEventEnablersByQuery()` is the basic search method and returns a list of `SupersedingEventEnablers`. A more advanced search may be performed with `getSupersedingEventEnablersBySearch()`.It accepts a `SupersedingEventEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as calendaring. `getSupersedingEventEnablersBySearch()` returns a `SupersedingEventEnablerSearchResults` that can be used to access the resulting `SupersedingEventEnablerList` or be used to perform a search within the result set through `SupersedingEventEnablerSearch`. This session defines views that offer differing behaviors for searching. federated calendar view: searches include superseding event enablers in calendars of which this calendar is an ancestor in the calendar hierarchy isolated calendar view: searches are restricted to superseding event enablers in this calendar `SupersedingEventEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `SupersedingEventEnablerQuery`.
Method	getSupersedingEventEnablerSearch
Description	Gets a superseding event enabler search.
Return	`osid.calendaring.rules.SupersedingEventEnablerSearch`		the superseding event enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventEnablerSearchOrder
Description	Gets a superseding event enabler search order. The `SupersedingEventEnablerSearchOrder` is supplied to a `SupersedingEventEnablerSearch` to specify the ordering of results.
Return	`osid.calendaring.rules.SupersedingEventEnablerSearchOrder`		the superseding event enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.rules.SupersedingEventEnablerQuery`	`supersedingEventEnablerQuery`	the superseding event enabler query
Parameters	`osid.calendaring.rules.SupersedingEventEnablerSearch`	`supersedingEventEnablerSearch`	the superseding event enabler search
Return	`osid.calendaring.rules.SupersedingEventEnablerSearchResults`		the superseding event search results
Errors	NULL_ARGUMENT		`supersedingEventEnablerQuery` or `supersedingEventEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`supersedingEventEnablerQuery` or `supersedingEventEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventEnablerQueryFromInspector
Description	Gets a superseding event enabler query from an inspector. The inspector is available from a `SupersedingEventEnablerSearchResults`.
Parameters	`osid.calendaring.rules.SupersedingEventEnablerQueryInspector`	`supersedingEventEnablerQueryInspector`	a superseding event enabler query inspector
Return	`osid.calendaring.rules.SupersedingEventEnablerQuery`		the superseding event enabler query
Errors	NULL_ARGUMENT		`supersedingEventEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`supersedingEventEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.