OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.DepotSearch
Implementsosid.OsidSearch
Description

The interface for governing depot searches.

MethodsearchAmongDepots
Description

Execute this search among the given list of depots.

Parametersosid.id.IdListdepotIdslist of depots
ErrorsNULL_ARGUMENT depotIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDepotResults
Description

Specify an ordering to the search results.

Parametersosid.installation.DepotSearchOrderdepotSearchOrderdepot search order
ErrorsNULL_ARGUMENT depotSearchOrder is null
UNSUPPORTED depotSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDepotSearchRecord
Description

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

Parametersosid.type.TypedepotSearchRecordTypea depot search record type
Returnosid.installation.records.DepotSearchRecordthe depot search record
ErrorsNULL_ARGUMENT depotSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(depotSearchRecordType) is false
CompliancemandatoryThis method must be implemented.