Interface | osid.financials.budgeting.BudgetEntrySearchOrder | ||
---|---|---|---|
Implements | osid.OsidRelationshipSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByBudget | ||
Description |
Specifies a preference for ordering the result set by budget. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBudgetSearchOrder | ||
Description |
Tests if a budget search order is available. | ||
Return | boolean | true if a budget search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetSearchOrder | ||
Description |
Gets the budget order. | ||
Return | osid.financials.budgeting.BudgetSearchOrder | the budget search order | |
Errors | UNIMPLEMENTED | supportsBudgetSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsBudgetSearchOrder()
is true. | |
Method | orderByAccount | ||
Description |
Specifies a preference for ordering the result set by 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 account search order is available. | ||
Return | boolean | true if an search account order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAccountSearchOrder | ||
Description |
Gets the account 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 | orderByAmount | ||
Description |
Specifies a preference for ordering the result set by the amount. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByDebit | ||
Description |
Specifies a preference for ordering the result set by the debit flag. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetEntrySearchOrderRecord | ||
Description |
Gets the budget entry search order record corresponding
to the given budget entry record | ||
Parameters | osid.type.Type | budgetEntryRecordType | a budget entry record type |
Return | osid.financials.budgeting.records.BudgetEntrySearchOrderRecord | the budget entry search order record | |
Errors | NULL_ARGUMENT | budgetEntryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(budgetEntryRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |