| Interface | osid.resource.ResourceRelationshipSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderBySourceResource | ||
| Description |
Specified a preference for ordering results by the resource. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSourceResourceSearchOrder | ||
| Description |
Tests if a | ||
| Return | boolean | true if a resource search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSourceResourceSearchOrder | ||
| Description |
Gets the search order for a resource. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | UNIMPLEMENTED | supportsSourceResourceSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsSourceResourceSearchOrder() is true. | |
| Method | orderByDestinationResource | ||
| Description |
Specified a preference for ordering results by the resource. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDestinationResourceSearchOrder | ||
| Description |
Tests if a | ||
| Return | boolean | true if a resource search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDestinationResourceSearchOrder | ||
| Description |
Gets the search order for a peer resource. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | UNIMPLEMENTED | supportsDestinationResourceSearchOrder() is false
| |
| Compliance | optional | This method must be implemented if
supportsDestinationResourceSearchOrder() is true. | |
| Method | getResourceRelationshipSearchOrderRecord | ||
| Description |
Gets the resource relationship search order record
corresponding to the given resource relationship record
| ||
| Parameters | osid.type.Type | resourceRelationshipRecordType | a resource relationship record type |
| Return | osid.resource.records.ResourceRelationshipSearchOrderRecord | the resource relationship search order record | |
| Errors | NULL_ARGUMENT | resourceRelationshipRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(ResourceRelationshipRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |