| Interface | osid.repository.AssetContentSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Used By | osid.repository.AssetContentSearchSession | ||
osid.repository.AssetContentSmartRepositorySession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByAsset | ||
| Description |
Specifies a preference for ordering the result set by asset. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsAssetSearchOrder | ||
| Description |
Tests if an asset order interface is available. | ||
| Return | boolean | true if an asset search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetSearchOrder | ||
| Description |
Gets the asset order. | ||
| Return | osid.repository.AssetSearchOrder | the asset search order for the source | |
| Errors | UNIMPLEMENTED | supportsAssetSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsAssetSearchOrder()
is true. | |
| Method | orderByDataLength | ||
| Description |
Specifies a preference for ordering the result set by data length. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByURL | ||
| Description |
Specifies a preference for ordering the result set by url. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetContentSearchOrderRecord | ||
| Description |
Gets the asset content search order record
corresponding to the given asset content record
| ||
| Parameters | osid.type.Type | assetContentRecordType | an asset content record type |
| Return | osid.repository.records.AssetContentSearchOrderRecord | the asset content search order record | |
| Errors | NULL_ARGUMENT | assetContentRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(assetContentRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |