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

Interface	osid.calendaring.rules.RecurringEventEnablerSearchSession
Implements	`osid.calendaring.rules.RecurringEventEnablerQuerySession`
Used By	`osid.calendaring.rules.CalendaringRulesManager`
Used By	`osid.calendaring.rules.CalendaringRulesProxyManager`
Description	This session provides methods for searching among `RecurringEventEnabler` objects. The search query is constructed using the `RecurringEventEnablerQuery`. `getRecurringEventEnablersByQuery()` is the basic search method and returns a list of `RecurringEventEnablers`. A more advanced search may be performed with `getRecurringEventEnablerBySearch()`. It accepts a `RecurringEventEnabler` in addition to the query for the purpose of specifying additional options affecting the entire search, such as calendaring. `geRecurringEventEnablersBySearch()` returns a `RecurringEventEnablerSearchResults` that can be used to access the resulting `RecurringEventEnablerList` or be used to perform a search within the result set through `RecurringEventEnablerSearch`. This session defines views that offer differing behaviors for searching. federated calendar view: searches include recurring event enablers in calendars of which this calendar is an ancestor in the calendar hierarchy isolated calendar view: searches are restricted to recurring event enablers in this calendar `RecurringEventEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `RecurringEventEnablerQuery`.
Method	getRecurringEventEnablerSearch
Description	Gets a recurring event enabler search.
Return	`osid.calendaring.rules.RecurringEventEnablerSearch`		the recurring event enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventEnablerSearchOrder
Description	Gets a recurring event enabler search order. The `RecurringEventEnablerSearchOrder` is supplied to a `RecurringEventEnablerSearch` to specify the ordering of results.
Return	`osid.calendaring.rules.RecurringEventEnablerSearchOrder`		the recurring event enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.rules.RecurringEventEnablerQuery`	`recurringEventEnablerQuery`	the recurring event enabler query
Parameters	`osid.calendaring.rules.RecurringEventEnablerSearch`	`recurringEventEnablerSearch`	the recurring event enabler search
Return	`osid.calendaring.rules.RecurringEventEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`recurringEventEnablerQuery` or `recurringEventEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`recurringEventEnablerQuery` or `recurringEventEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventEnablerQueryFromInspector
Description	Gets a recurring event enabler query from an inspector. The inspector is available from a `RecurringEventEnablerSearchResults`.
Parameters	`osid.calendaring.rules.RecurringEventEnablerQueryInspector`	`recurringEventEnablerQueryInspector`	a recurring event enabler query inspector
Return	`osid.calendaring.rules.RecurringEventEnablerQuery`		the recurring event enabler query
Errors	NULL_ARGUMENT		`recurringEventEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`recurringEventEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.