| Interface | osid.financials.FiscalPeriodSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing fiscal period searches. | ||
| Method | searchAmongFiscalPeriods | ||
| Description |
Execute this search among the given list of fiscal periods. | ||
| Parameters | osid.id.IdList | fiscalPeriodIds | list of fiscal periods |
| Errors | NULL_ARGUMENT | fiscalPeriodIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderFiscalPeriodResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.financials.FiscalPeriodSearchOrder | fiscalPeriodSearchOrder | a fiscal period search order |
| Errors | NULL_ARGUMENT | fiscalPeriodSearchOrder is null | |
| UNSUPPORTED | fiscalPeriodSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getFiscalPeriodSearchRecord | ||
| Description |
Gets the fiscal period search record corresponding to
the given fiscal period search record | ||
| Parameters | osid.type.Type | fiscalPeriodSearchRecordType | a discal period search record type |
| Return | osid.financials.records.FiscalPeriodSearchRecord | the fiscal period search record | |
| Errors | NULL_ARGUMENT | fiscalPeriodSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(fiscalPeriodSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |