OSID - osid.financials.FiscalPeriodSearchSession Service Interface Definition

Interface	osid.financials.FiscalPeriodSearchSession
Implements	`osid.financials.FiscalPeriodQuerySession`
Description	This session provides methods for searching among `FiscalPeriod` objects. The search query is constructed using the `FiscalPeriodQuery.` `getFiscalPeriodsByQuery()` is the basic search method and returns a list of `FiscalPeriods.` A more advanced search may be performed with `getFiscalPeriodsBySearch().` It accepts a `FiscalPeriodSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getFiscalPeriodsBySearch()` returns a `FiscalPeriodSearchResults` that can be used to access the resulting `FiscalPeriodList` or be used to perform a search within the result set through `FiscalPeriodSearch.` This session defines views that offer differing behaviors for searching. federated business view: searches include fiscal periods in businesses of which this business is an ancestor in the business hierarchy isolated business view: searches are restricted to fiscal periods in this business Fiscal Periods may have a query record indicated by their respective record types. The queryrecord is accessed via the `FiscalPeriodQuery.`
Method	getFiscalPeriodSearch
Description	Gets a fiscal period search.
Return	`osid.financials.FiscalPeriodSearch`		the fiscal period search
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodSearchOrder
Description	Gets a fiscal period search order. The `FiscalPeriodSearchOrder` is supplied to a `FiscalPeriodSearch` to specify the ordering of results.
Return	`osid.financials.FiscalPeriodSearchOrder`		the fiscal period search order
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.financials.FiscalPeriodQuery`	`fiscalPeriodQuery`	the fiscal period query
Parameters	`osid.financials.FiscalPeriodSearch`	`fiscalPeriodSearch`	the fiscal period search
Return	`osid.financials.FiscalPeriodSearchResults`		the fiscal period search results
Errors	NULL_ARGUMENT		`fiscalPeriodQuery` or `fiscalPeriodSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`fiscalPeriodQuery` or `fiscalPeriodSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodQueryFromInspector
Description	Gets a fiscal period query from an inspector. The inspector is available from a `FiscalPeriodSearchResults.`
Parameters	`osid.assessment.ItemQueryInspector`	`fiscalPeriodQueryInspector`	a fiscal period query inspector
Return	`osid.financials.FiscalPeriodQuery`		the fiscal period query
Errors	NULL_ARGUMENT		`fiscalPeriodQueryInspector` is `null`
Errors	UNSUPPORTED		`fiscalPeriodQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.