Interface | osid.financials.budgeting.BudgetSearchOrder | ||
---|---|---|---|
Implements | osid.OsidRelationshipSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByActivity | ||
Description |
Specifies a preference for ordering the result set by activity. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActivitySearchOrder | ||
Description |
Tests if an activity search order is available. | ||
Return | boolean | true if an activity search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivitySearchOrder | ||
Description |
Gets the activity search order. | ||
Return | osid.financials.ActivitySearchOrder | the activity search order | |
Errors | UNIMPLEMENTED | supportsActivitySearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsActivitySearchOrder()
is true. | |
Method | orderByFiscalPeriod | ||
Description |
Specifies a preference for ordering the result set by 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 fiscal period search order is available. | ||
Return | boolean | true if a fiscal period search order is available,
false otherwise | |
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 | getBudgetSearchOrderRecord | ||
Description |
Gets the budget search order record corresponding to
the given budget record | ||
Parameters | osid.type.Type | budgetRecordType | a budget record type |
Return | osid.financials.budgeting.records.BudgetSearchOrderRecord | the budget search order record | |
Errors | NULL_ARGUMENT | budgetRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(budgetRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |