Interface | osid.repository.AssetSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getAssets | ||
Description |
Gets the asset list resulting from a search. | ||
Return | osid.repository.AssetList | the asset list | |
Errors | ILLEGAL_STATE | the list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssetQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.repository.AssetQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssetSearchResultsRecord | ||
Description |
Gets the asset search results record corresponding to
the given asset search record | ||
Parameters | osid.type.Type | assetSearchRecordType | an asset search record type |
Return | osid.repository.records.AssetSearchResultsRecord | the asset search results 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. |