OSID Specifications
financials package
Version 3.0.0
financials package
Version 3.0.0
| Interface | osid.financials.FiscalPeriodSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Used By | osid.financials.FiscalPeriodSearchSession | ||
osid.financials.FiscalPeriodSmartBusinessSession | |||
osid.financials.SummarySearchOrder | |||
osid.financials.budgeting.BudgetSearchOrder | |||
osid.financials.posting.PostSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByDisplayLabel | ||
| Description |
Specifies a preference for ordering the result set by display label. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByFiscalYear | ||
| Description |
Specifies a preference for ordering the result set by year. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByStartDate | ||
| Description |
Specifies a preference for ordering the result set by fiscal period start date. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByEndDate | ||
| Description |
Specifies a preference for ordering the result set by fiscal period end date. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDuration | ||
| Description |
Specifies a preference for ordering the result set by duration. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByBudgetDeadline | ||
| Description |
Specifies a preference for ordering the result set by the budget deadline. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByPostingDeadline | ||
| Description |
Specifies a preference for ordering the result set by the posting deadline. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByClosing | ||
| Description |
Specifies a preference for ordering the result set by the closing date. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFiscalPeriodSearchOrderRecord | ||
| Description |
Gets the fiscal period search order record
corresponding to the given fiscal period record
| ||
| Parameters | osid.type.Type | fiscalPeriodRecordType | a fiscal period record type |
| Return | osid.financials.records.FiscalPeriodSearchOrderRecord | the fiscal period search order record | |
| Errors | NULL_ARGUMENT | fiscalPeriodRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(fiscalPeriodRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |