Interface | osid.financials.FiscalPeriodSearchSession | ||
---|---|---|---|
Implements | osid.financials.FiscalPeriodQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Fiscal Periods may have a query record indicated by their
respective record types. The queryrecord is accessed via the
| ||
Method | getFiscalPeriodSearch | ||
Description |
Gets a fiscal period search. | ||
Return | osid.financials.FiscalPeriodSearch | the fiscal period search | |
Compliance | mandatory | This method must be implemented. | |
Method | getFiscalPeriodSearchOrder | ||
Description |
Gets a fiscal period search order. The | ||
Return | osid.financials.FiscalPeriodSearchOrder | the fiscal period search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getFiscalPeriodsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.financials.FiscalPeriodQuery | fiscalPeriodQuery | the fiscal period query |
osid.financials.FiscalPeriodSearch | fiscalPeriodSearch | the fiscal period search | |
Return | osid.financials.FiscalPeriodSearchResults | the fiscal period search results | |
Errors | NULL_ARGUMENT | fiscalPeriodQuery or fiscalPeriodSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | fiscalPeriodQuery or fiscalPeriodSearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFiscalPeriodQueryFromInspector | ||
Description |
Gets a fiscal period query from an inspector. The
inspector is available from a | ||
Parameters | osid.assessment.ItemQueryInspector | fiscalPeriodQueryInspector | a fiscal period query inspector |
Return | osid.financials.FiscalPeriodQuery | the fiscal period query | |
Errors | NULL_ARGUMENT | fiscalPeriodQueryInspector is null | |
UNSUPPORTED | fiscalPeriodQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |