OSID - osid.calendaring.TimePeriodSearchSession Service Interface Definition

Interface	osid.calendaring.TimePeriodSearchSession
Implements	`osid.calendaring.TimePeriodQuerySession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session provides methods for searching `TimePeriod` objects. The search query is constructed using the `TimePeriodQuery`. The time period record `Type` also specifies the record for the time period query. `getTimePeriodsByQuery()` is the basic search method and returns a list of `TimePeriods`. A more advanced search may be performed with `getTimePeriodsBySearch()`.It accepts a `TimePeriodSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getTimePeriodsBySearch()` returns a `TimePeriodSearchResults` that can be used to access the resulting `TimePeriodList` or be used to perform a search within the result set through `TimePeriodSearch`. Time periods may have a query record indicated by their respective record types. The query record is accessed via the `TimePeriodQuery`.
Method	getTimePeriodSearch
Description	Gets a time period search.
Return	`osid.calendaring.TimePeriodSearch`		the time period search
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodSearchOrder
Description	Gets a time period search order. The `TimePeriodSearchOrder` is supplied to a `TimePeriodSearch` to specify the ordering of results.
Return	`osid.calendaring.TimePeriodSearchOrder`		the time period search order
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.TimePeriodQuery`	`timePeriodQuery`	the time period query
Parameters	`osid.calendaring.TimePeriodSearch`	`timePeriodSearch`	the time period search
Return	`osid.calendaring.TimePeriodSearchResults`		the time period search results
Errors	NULL_ARGUMENT		`timePeriodQuery` or `timePeriodSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`timePeriodSearch` or t `imePeriodQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodQueryFromInspector
Description	Gets a time period query from an inspector. The inspector is available from a `TimePeriodSearchResults`.
Parameters	`osid.calendaring.TimePeriodQueryInspector`	`timePeriodQueryInspector`	a time period query inspector
Return	`osid.calendaring.TimePeriodQuery`		the time period query
Errors	NULL_ARGUMENT		`timePeriodQueryInspector` is `null`
Errors	UNSUPPORTED		`timePeriodQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.