OSID - osid.billing.PeriodSearchSession Service Interface Definition

Interface	osid.billing.PeriodSearchSession
Implements	`osid.billing.PeriodQuerySession`
Description	This session provides methods for searching among `Period` objects. The search query is constructed using the `PeriodQuery.` `getPeriodsByQuery()` is the basic search method and returns a list of `Periods.` A more advanced search may be performed with `getPeriodsBySearch().` It accepts a `PeriodSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPeriodsBySearch()` returns a `PeriodsSearchResults` that can be used to access the resulting `PeriodList` or be used to perform a search within the result set through `PeriodSearch.` This session defines views that offer differing behaviors for searching. federated business view: searches include periods in businesses of which this business is an ancestor in the business hierarchy isolated business view: searches are restricted to periods in this business Periods may have a query record indicated by their respective record types. The query record is accessed via the `PeriodQuery.`
Method	getPeriodSearch
Description	Gets a period search.
Return	`osid.billing.PeriodSearch`		the period search
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodSearchOrder
Description	Gets a period search order. The `PeriodSearchOrder` is supplied to a `PeriodSearch` to specify the ordering of results.
Return	`osid.billing.PeriodSearchOrder`		the period search order
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.billing.PeriodQuery`	`periodQuery`	the period query
Parameters	`osid.billing.PeriodSearch`	`periodSearch`	the period search
Return	`osid.billing.PeriodSearchResults`		the period search results
Errors	NULL_ARGUMENT		`periodQuery` or `periodSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`periodQuery` or `periodSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodQueryFromInspector
Description	Gets a period query from an inspector. The inspector is available from a `PeriodSearchResults.`
Parameters	`osid.billing.PeriodQueryInspector`	`periodQueryInspector`	a period query inspector
Return	`osid.billing.PeriodQuery`		the period query
Errors	NULL_ARGUMENT		`periodQueryInspector` is `null`
Errors	UNSUPPORTED		`periodQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.