OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.FiscalPeriodSearch
Implementsosid.OsidSearch
Description

The search interface for governing fiscal period searches.

MethodsearchAmongFiscalPeriods
Description

Execute this search among the given list of fiscal periods.

Parametersosid.id.IdListfiscalPeriodIdslist of fiscal periods
ErrorsNULL_ARGUMENT fiscalPeriodIds is null
CompliancemandatoryThis method must be implemented.
MethodorderFiscalPeriodResults
Description

Specify an ordering to the search results.

Parametersosid.financials.FiscalPeriodSearchOrderfiscalPeriodSearchOrdera fiscal period search order
ErrorsNULL_ARGUMENT fiscalPeriodSearchOrder is null
UNSUPPORTED fiscalPeriodSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodSearchRecord
Description

Gets the fiscal period search 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 discal period search record type
Returnosid.financials.records.FiscalPeriodSearchRecordthe fiscal period search record
ErrorsNULL_ARGUMENT fiscalPeriodSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(fiscalPeriodSearchRecordType) is false
CompliancemandatoryThis method must be implemented.