OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
repository package
Version 3.0.0
Release Candidate Preview
| Interface | osid.repository.AssetSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing asset searches. | ||
| Method | searchAmongAssets | ||
| Description |
Execute this search among the given list of assets. | ||
| Parameters | osid.id.IdList | assetIds | list of asset Ids |
| Errors | NULL_ARGUMENT | assetIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderAssetResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.repository.AssetSearchOrder | assetSearchOrder | asset search order |
| Errors | NULL_ARGUMENT | assetSearchOrder is null | |
| UNSUPPORTED | assetSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssetSearchRecord | ||
| Description |
Gets the asset search record corresponding to the given
asset search record | ||
| Parameters | osid.type.Type | assetSearchRecordType | an asset search record type |
| Return | osid.repository.records.AssetSearchRecord | the asset search record | |
| Errors | NULL_ARGUMENT | assetSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(assetSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |