OSID - osid.calendaring.CalendarSearchSession Service Interface Definition

Interface	osid.calendaring.CalendarSearchSession
Implements	`osid.calendaring.CalendarQuerySession`
Description	This session provides methods for searching among `Calendar` objects. The search query is constructed using the `CalendarQuery.` `getCalendarsByQuery()` is the basic search method and returns a list of `Calendar` objects.A more advanced search may be performed with `getCalendarsBySearch().` It accepts a `CalendarSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCalendarsBySearch()` returns a `CalendarSearchResults` that can be used to access the resulting `CalendarList` or be used to perform a search within the result set through `CalendarSearch.` Calendars may have a query record indicated by their respective record types. The query record is accessed via the `CalendarQuery.`
Method	canSearchCalendars
Description	Tests if this user can perform `Calendar` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarSearch
Description	Gets a calendar search.
Return	`osid.calendaring.CalendarSearch`		a calendar search
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarSearchOrder
Description	Gets a calendar search order. The `CalendarSearchOrder` is supplied to a `CalendarSearch` to specify the ordering of results.
Return	`osid.calendaring.CalendarSearchOrder`		the calendar search order
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.CalendarQuery`	`calendarQuery`	the calendar query
Parameters	`osid.calendaring.CalendarSearch`	`calendarSearch`	the calendar search
Return	`osid.calendaring.CalendarSearchResults`		the calendar search results
Errors	NULL_ARGUMENT		`calendarQuery` or `calendarSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`calendarQuery` or `calendarSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarQueryFromInspector
Description	Gets a calendar query from an inspector. The inspector is available from an `CalendarSearchResults.`
Parameters	`osid.calendaring.CalendarQueryInspector`	`calendarQueryInspector`	a calendar query inspector
Return	`osid.calendaring.CalendarQuery`		the calendar query
Errors	NULL_ARGUMENT		`calendarQueryInspector` is `null`
Errors	UNSUPPORTED		`calendarQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.