OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.AssetSearch
Implementsosid.OsidSearch
Description

The search interface for governing asset searches.

MethodsearchAmongAssets
Description

Execute this search among the given list of assets.

Parametersosid.id.IdListassetIdslist of asset Ids
ErrorsNULL_ARGUMENT assetIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAssetResults
Description

Specify an ordering to the search results.

Parametersosid.repository.AssetSearchOrderassetSearchOrderasset search order
ErrorsNULL_ARGUMENT assetSearchOrder is null
UNSUPPORTED assetSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAssetSearchRecord
Description

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

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