OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.AssetSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetAssets
Description

Gets the asset list resulting from a search.

Returnosid.repository.AssetListthe asset list
ErrorsILLEGAL_STATEthe list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetAssetQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.repository.AssetQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetAssetSearchResultsRecord
Description

Gets the asset search results record corresponding to the given asset search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeassetSearchRecordTypean asset search record type
Returnosid.repository.records.AssetSearchResultsRecordthe asset search results record
ErrorsNULL_ARGUMENT assetSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(assetSearchRecordType) is false
CompliancemandatoryThis method must be implemented.