| Interface | osid.acknowledgement.CreditSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByReference | ||
| Description |
Specifies a preference for ordering the result set by the reference. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByResource | ||
| Description |
Specifies a preference for ordering the result set by the resource. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsResourceSearchOrder | ||
| Description |
Tests if a resource search order is available. | ||
| Return | boolean | true if a resource search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceSearchOrder | ||
| Description |
Gets the resource search order. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | UNIMPLEMENTED | supportsResourceSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsResourceSearchOrder()
is true. | |
| Method | getCreditSearchOrderRecord | ||
| Description |
Gets the credit search order record corresponding to
the given credit record | ||
| Parameters | osid.type.Type | creditRecordType | a credit record type |
| Return | osid.acknowledgement.records.CreditSearchOrderRecord | the credit search order record | |
| Errors | NULL_ARGUMENT | creditRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(creditRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |