Interface | osid.financials.FiscalPeriodSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getFiscalPeriods | ||
Description |
Gets the fiscal period list resulting from a search. | ||
Return | osid.financials.FiscalPeriodList | the fiscal period list | |
Errors | ILLEGAL_STATE | the fiscal period list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getFiscalPeriodQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.financials.FiscalPeriodQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getFiscalPeriodSearchResultsRecord | ||
Description |
Gets the fiscal period search results record
corresponding to the given fiscal period search record
| ||
Parameters | osid.type.Type | fiscalPeriodSearchRecordType | a fiscal period search record type |
Return | osid.financials.records.FiscalPeriodSearchResultsRecord | the fiscal period search results 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. |