OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.FiscalPeriodSearchSession
Implementsosid.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.

MethodgetFiscalPeriodSearch
Description

Gets a fiscal period search.

Returnosid.financials.FiscalPeriodSearchthe fiscal period search
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodSearchOrder
Description

Gets a fiscal period search order. The FiscalPeriodSearchOrder is supplied to a FiscalPeriodSearch to specify the ordering of results.

Returnosid.financials.FiscalPeriodSearchOrderthe fiscal period search order
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.financials.FiscalPeriodQueryfiscalPeriodQuerythe fiscal period query
osid.financials.FiscalPeriodSearchfiscalPeriodSearchthe fiscal period search
Returnosid.financials.FiscalPeriodSearchResultsthe fiscal period search results
ErrorsNULL_ARGUMENT fiscalPeriodQuery or fiscalPeriodSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED fiscalPeriodQuery or fiscalPeriodSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodQueryFromInspector
Description

Gets a fiscal period query from an inspector. The inspector is available from a FiscalPeriodSearchResults.

Parametersosid.assessment.ItemQueryInspectorfiscalPeriodQueryInspectora fiscal period query inspector
Returnosid.financials.FiscalPeriodQuerythe fiscal period query
ErrorsNULL_ARGUMENT fiscalPeriodQueryInspector is null
UNSUPPORTED fiscalPeriodQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.