OSID - osid.calendaring.OffsetEventSearchSession Service Interface Definition

Interface	osid.calendaring.OffsetEventSearchSession
Implements	`osid.calendaring.OffsetEventQuerySession`
Description	This session provides methods for searching `OffsetEvent` objects. The search query is constructed using the `OffsetEventQuery.` The offset event record `Type` also specifies the record for the offset event query. `getOffsetEventsByQuery()` is the basic search method and returns a list of `OffsetEvents.` A more advanced search may be performed with `getOffsetEventsBySearch().` It accepts an `OffsetEventSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getOffsetEventsBySearch()` returns an `OffsetEventSearchResults` that can be used to access the resulting `OffsetEventList` or be used to perform a search within the result set through `OffsetEventSearch.` This session defines views that offer differing behaviors for searching. federated calendar view: searches include offset events in calendars of which this calendar is a ancestor in the calendar hierarchy isolated calendar view: searches are restricted to offset events in this calendar Offset events may have a query record indicated by their respective record types. The query record is accessed via the `OffsetEventQuery.`
Method	getOffsetEventSearch
Description	Gets an offset event search.
Return	`osid.calendaring.OffsetEventSearch`		the offset event search
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventSearchOrder
Description	Gets an offset event search order. The `OffsetEventSearchOrder` is supplied to an `OffsetEventSearch` to specify the ordering of results.
Return	`osid.calendaring.OffsetEventSearchOrder`		the offset event search order
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.OffsetEventQuery`	`offsetEventQuery`	the offset event search query
Parameters	`osid.calendaring.OffsetEventSearch`	`offsetEventSearch`	the offset event search
Return	`osid.calendaring.OffsetEventSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`offsetEventQuery` or `offsetEventSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`offsetEventQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventQueryFromInspector
Description	Gets an offset event query from an inspector. The inspector is available from an `OffsetEventSearchResults.`
Parameters	`osid.calendaring.OffsetEventQueryInspector`	`offsetEventQueryInspector`	an offset event query inspector
Return	`osid.calendaring.OffsetEventQuery`		the offset event query
Errors	NULL_ARGUMENT		`offsetEventQueryInspector` is `null`
Errors	UNSUPPORTED		`offsetEventQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.