OSID Specifications
financials package
Version 3.1.0
financials package
Version 3.1.0
| Interface | osid.financials.SummarySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidCompendiumSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByAccount | ||
| Description |
Specifies a preference for ordering the result set by the account. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsAccountSearchOrder | ||
| Description |
Tests if an | ||
| Return | boolean | true if an account search order is available,
false otherwise | |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAccountSearchOrder | ||
| Description |
Gets the account search order. | ||
| Return | osid.financials.AccountSearchOrder | the account search order | |
| Errors | UNIMPLEMENTED | supportsAccountSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsAccountSearchOrder() is true. | |
| Method | orderByFiscalPeriod | ||
| Description |
Specifies a preference for ordering the result set by the fiscal period. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsFiscalPeriodSearchOrder | ||
| Description |
Tests if a | ||
| Return | boolean | true if a fiscal period search order is available,
false otherwise | |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFiscalPeriodSearchOrder | ||
| Description |
Gets the fiscal period search order. | ||
| Return | osid.financials.FiscalPeriodSearchOrder | the fiscal period search order | |
| Errors | UNIMPLEMENTED | supportsFiscalPeriodSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsFiscalPeriodSearchOrder() is true. | |
| Method | orderByCredits | ||
| Description |
Specifies a preference for ordering the result set by the credits. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDebits | ||
| Description |
Specifies a preference for ordering the result set by the debits. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByBalance | ||
| Description |
Specifies a preference for ordering the result set by the balance. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByBudget | ||
| Description |
Specifies a preference for ordering the result set by the budget | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDelta | ||
| Description |
Specifies a preference for ordering the result set by the delta. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByForecast | ||
| Description |
Specifies a preference for ordering the result set by the forecast. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSummarySearchOrderRecord | ||
| Description |
Gets the fiscal period search order record
corresponding to the given fiscal period record
| ||
| Parameters | osid.type.Type | summaryRecordType | a summary record type |
| Return | osid.financials.records.SummarySearchOrderRecord | the summary search order record | |
| Errors | NULL_ARGUMENT | summaryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(summaryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |