OSID Logo
OSID Specifications
installation package
Version 3.1.0
Interfaceosid.installation.DepotSearch
Implementsosid.OsidSearch
Used Byosid.installation.DepotSearchSession
Description

The interface for governing depot searches.

MethodsearchAmongDepots
Description

Execute this search among the given list of depots.

Parametersosid.id.IdListdepotIds list of depots
ErrorsNULL_ARGUMENT depotIds is null
Compliancemandatory This method must be implemented.
MethodorderDepotResults
Description

Specify an ordering to the search results.

Parametersosid.installation.DepotSearchOrderdepotSearchOrder depot search order
ErrorsNULL_ARGUMENT depotSearchOrder is null
UNSUPPORTED depotSearchOrder is not of this service
Compliancemandatory This 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.TypedepotSearchRecordType a depot search record type
Returnosid.installation.records.DepotSearchRecord the depot search record
ErrorsNULL_ARGUMENT depotSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(depotSearchRecordType) is false
Compliancemandatory This method must be implemented.