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

Interface	osid.calendaring.rules.OffsetEventEnablerSearchSession
Implements	`osid.calendaring.rules.OffsetEventEnablerQuerySession`
Used By	`osid.calendaring.rules.CalendaringRulesManager`
Used By	`osid.calendaring.rules.CalendaringRulesProxyManager`
Description	This session provides methods for searching among `OffsetEventEnabler` objects. The search query is constructed using the `OffsetEventEnablerQuery`. `getOffsetEventEnablersByQuery()` is the basic search method and returns a list of `OffsetEventEnablers`. A more advanced search may be performed with `getOffsetEventEnablersBySearch()`. It accepts an `OffsetEventEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as calendaring. `getOffsetEventEnablersBySearch()` returns an `OffsetEventEnablerSearchResults` that can be used to access the resulting `OffsetEventEnablerList` or be used to perform a search within the result set through `OffsetEventEnablerSearch`. This session defines views that offer differing behaviors for searching. federated calendar view: searches include offset event enablers in calendars of which this calendar is an ancestor in the calendar hierarchy isolated calendar view: searches are restricted to offset event enablers in this calendar `OffsetEventEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `OffsetEventEnablerQuery`.
Method	getOffsetEventEnablerSearch
Description	Gets an offset event enabler search.
Return	`osid.calendaring.rules.OffsetEventEnablerSearch`		the offset event enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventEnablerSearchOrder
Description	Gets an offset event enabler search order. The `OffsetEventEnablerSearchOrder` is supplied to an `OffsetEventEnablerSearch` to specify the ordering of results.
Return	`osid.calendaring.rules.OffsetEventEnablerSearchOrder`		the offset event enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.rules.OffsetEventEnablerQuery`	`offsetEventEnablerQuery`	the offset event enabler query
Parameters	`osid.calendaring.rules.OffsetEventEnablerSearch`	`offsetEventEnablerSearch`	the offset event enabler search
Return	`osid.calendaring.rules.OffsetEventEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`offsetEventEnablerQuery` or `offsetEventEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`offsetEventEnablerQuery` or `offsetEventEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventEnablerQueryFromInspector
Description	Gets an offset event enabler query from an inspector. The inspector is available from an `OffsetEventEnablerSearchResults`.
Parameters	`osid.calendaring.rules.OffsetEventEnablerQueryInspector`	`offsetEventEnablerQueryInspector`	an offset event enabler query inspector
Return	`osid.calendaring.rules.OffsetEventEnablerQuery`		the offset event enabler query
Errors	NULL_ARGUMENT		`offsetEventEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`offsetEventEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.