OSID - osid.calendaring.ScheduleSlotSearchSession Service Interface Definition

Interface	osid.calendaring.ScheduleSlotSearchSession
Implements	`osid.calendaring.ScheduleSlotQuerySession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session provides methods for searching `ScheduleSlot` objects. The search query is constructed using the `ScheduleSlotQuery`. The schedule slot record `Type` also specifies the record for the schedule slot query. `getScheduleSlotsByQuery()` is the basic search method and returns a list of `ScheduleSlots`. A more advanced search may be performed with `getScheduleSlotsBySearch()`.It accepts a `ScheduleSlotSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getScheduleSlotsBySearch()` returns a `ScheduleSlotSearchResults` that can be used to access the resulting `ScheduleSlotsList` or be used to perform a search within the result set through `ScheduleSlotSearch`. This session defines views that offer differing behaviors for searching. federated calendar view: searches include schedule slots in calendars of which this calendar is an ancestor in the calendar hierarchy isolated calendar view: searches are restricted to schedule slots in this calendar Schedule slots may have a query record indicated by their respective record types. The query record is accessed via the `ScheduleSlotQuery`.
Method	getScheduleSlotSearch
Description	Gets a schedule slot search.
Return	`osid.calendaring.ScheduleSlotSearch`		the schedule slot search
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotSearchOrder
Description	Gets a schedule slot search order. The `ScheduleSlotSearchOrder` is supplied to a `ScheduleSlotSearch` to specify the ordering of results.
Return	`osid.calendaring.ScheduleSlotSearchOrder`		the schedule slot search order
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.ScheduleSlotQuery`	`scheduleSlotQuery`	the schedule slot query
Parameters	`osid.calendaring.ScheduleSlotSearch`	`scheduleSlotSearch`	the schedule slot search
Return	`osid.calendaring.ScheduleSearchResults`		the schedule slot search results
Errors	NULL_ARGUMENT		`scheduleSlotQuery` or `scheduleSlotSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`scheduleSlotSearch` or `scheduleSlotQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotQueryFromInspector
Description	Gets a schedule slot query from an inspector. The inspector is available from an `ScheduleSlotSearchResults`.
Parameters	`osid.calendaring.ScheduleSlotQueryInspector`	`scheduleSlotQueryInspector`	a schedule slot query inspector
Return	`osid.calendaring.ScheduleSlotQuery`		the schedule query
Errors	NULL_ARGUMENT		`scheduleSlotQueryInspector` is `null`
Errors	UNSUPPORTED		`scheduleSlotQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.