| Interface | osid.financials.posting.PostEntrySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByPost | ||
| Description |
Specifies a preference for ordering the result set by post. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPostSearchOrder | ||
| Description |
Tests if a post search order is available. | ||
| Return | boolean | true if a post search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostSearchOrder | ||
| Description |
Gets the post order. | ||
| Return | osid.financials.posting.PostSearchOrder | the post search order | |
| Errors | UNIMPLEMENTED | supportsPostSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsPostSearchOrder()
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 | 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 | 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 | getPostEntrySearchOrderRecord | ||
| Description |
Gets the post entry search order record corresponding
to the given post entry record | ||
| Parameters | osid.type.Type | postEntryRecordType | a post entry record type |
| Return | osid.financials.posting.records.PostEntrySearchOrderRecord | the post entry search order record | |
| Errors | NULL_ARGUMENT | postEntryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(postEntryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |