OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.FiscalPeriodSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetFiscalPeriods
Description

Gets the fiscal period list resulting from a search.

Returnosid.financials.FiscalPeriodListthe fiscal period list
ErrorsILLEGAL_STATEthe fiscal period list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.financials.FiscalPeriodQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodSearchResultsRecord
Description

Gets the fiscal period search results record corresponding to the given fiscal period search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypefiscalPeriodSearchRecordTypea fiscal period search record type
Returnosid.financials.records.FiscalPeriodSearchResultsRecordthe fiscal period search results record
ErrorsNULL_ARGUMENT fiscalPeriodSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(fiscalPeriodSearchRecordType) is false
CompliancemandatoryThis method must be implemented.