OSID - osid.calendaring.cycle.CyclicTimePeriodSearchSession Service Interface Definition

Interface	osid.calendaring.cycle.CyclicTimePeriodSearchSession
Implements	`osid.calendaring.cycle.CyclicTimePeriodQuerySession`
Used By	`osid.calendaring.cycle.CalendaringCycleManager`
Used By	`osid.calendaring.cycle.CalendaringCycleProxyManager`
Description	This session provides methods for searching `CyclicTimePeriods`. The search query is constructed using the `CyclicTimePeriodQuery`. The cyclic time period record `Type` also specifies the record for the cyclic time period query. `getCyclicTimePeriodsByQuery()` is the basic search method and returns a list of `CyclicTimePeriods`. A more advanced search may be performed with `getCyclicTimePeriodsBySearch()`. It accepts a `CyclicTimePeriodSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCyclicTimePeriodsBySearch()` returns a `CyclicTimePeriodSearchResults` that can be used to access the resulting `CyclicTimePeriodList` or be used to perform a search within the result set through `CyclicTimePeriodSearch`. Cyclic time periods may have a query record indicated by their respective record types. The query record is accessed via the `CyclicTimePeriodQuery`.
Method	getCyclicTimePeriodSearch
Description	Gets a cyclic time period search.
Return	`osid.calendaring.cycle.CyclicTimePeriodSearch`		the cyclic time period search
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodSearchOrder
Description	Gets a cyclic time period search order. The `CyclicTimePeriodSearchOrder` is supplied to a `CyclicTimePeriodSearch` to specify the ordering of results.
Return	`osid.calendaring.cycle.CyclicTimePeriodSearchOrder`		the cyclic time period search order
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.calendaring.cycle.CyclicTimePeriodQuery`	`cyclicTimePeriodQuery`	the cyclic time period query
Parameters	`osid.calendaring.cycle.CyclicTimePeriodSearch`	`cyclicTimePeriodSearch`	the cyclic time period search
Return	`osid.calendaring.cycle.CyclicTimePeriodSearchResults`		the cyclic time period search results
Errors	NULL_ARGUMENT		`cyclicTimePeriodQuery` or `cyclicTimePeriodSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`cyclicTimePeriodSearch` or t `imePeriodQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodQueryFromInspector
Description	Gets a cyclic time period query from an inspector. The inspector is available from a `CyclicTimePeriodSearchResults`.
Parameters	`osid.calendaring.cycle.CyclicTimePeriodQueryInspector`	`cyclicTimePeriodQueryInspector`	a cyclic time period query inspector
Return	`osid.calendaring.cycle.CyclicTimePeriodQuery`		the cyclic time period query
Errors	NULL_ARGUMENT		`cyclicTimePeriodQueryInspector` is `null`
Errors	UNSUPPORTED		`cyclicTimePeriodQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.