OSID - osid.calendaring.ScheduleSearchSession Service Interface Definition

Interface	osid.calendaring.ScheduleSearchSession
Implements	`osid.calendaring.ScheduleQuerySession`
Description	This session provides methods for searching `Schedule` objects. The search query is constructed using the `ScheduleQuery.` The schedule record `Type` also specifies the record for the schedule query. `getSchedulesByQuery()` is the basic search method and returns a list of `Schedules.` A more advanced search may be performed with `getSchedulesBySearch().` It accepts a `ScheduleSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getSchedulesBySearch()` returns a `ScheduleSearchResults` that can be used to access the resulting `SchedulesList` or be used to perform a search within the result set through `ScheduleSearch.` This session defines views that offer differing behaviors for searching. federated calendar view: searches include schedules in calendars of which this calendar is a ancestor in the calendar hierarchy isolated calendar view: searches are restricted to schedules in this calendar Schedules may have a query record indicated by their respective record types. The query record is accessed via the `ScheduleQuery.`
Method	getScheduleSearch
Description	Gets a schedule search.
Return	`osid.calendaring.ScheduleSearch`		the schedule search
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSearchOrder
Description	Gets a schedule search order. The `ScheduleSearchOrder` is supplied to a `ScheduleSearch` to specify the ordering of results.
Return	`osid.calendaring.ScheduleSearchOrder`		the schedule search order
Compliance	`mandatory`		This method must be implemented.
Method	getSchedulesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.ScheduleQuery`	`scheduleQuery`	the schedule query
Parameters	`osid.calendaring.ScheduleSearch`	`scheduleSearch`	the schedule search
Return	`osid.calendaring.ScheduleSearchResults`		the schedule search results
Errors	NULL_ARGUMENT		`scheduleQuery` or `scheduleSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`scheduleSearch` or `scheduleQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleQueryFromInspector
Description	Gets a schedule query from an inspector. The inspector is available from an `ScheduleSearchResults.`
Parameters	`osid.calendaring.ScheduleQueryInspector`	`scheduleQueryInspector`	a schedule query inspector
Return	`osid.calendaring.ScheduleQuery`		the schedule query
Errors	NULL_ARGUMENT		`scheduleQueryInspector` is `null`
Errors	UNSUPPORTED		`scheduleQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.