OSID Logo
OSID Specifications
installation package
Version 3.1.0
Interfaceosid.installation.DepotSearchResults
Implementsosid.OsidSearchResults
Used Byosid.installation.DepotSearchSession
Description

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

MethodgetDepots
Description

Gets the depot list resulting from the search.

Returnosid.installation.DepotList the depot list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetDepotQueryInspector
Description

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

Returnosid.installation.DepotQueryInspector the depot query inspector
Compliancemandatory This method must be implemented.
MethodgetDepotSearchResultsRecord
Description

Gets the depot search results 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.DepotSearchResultsRecord the depot search results record
ErrorsNULL_ARGUMENT depotSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(depotSearchRecordType) is false
Compliancemandatory This method must be implemented.