OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.DepotSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetDepots
Description

Gets the depot list resulting from the search.

Returnosid.installation.DepotListthe depot list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetDepotQueryInspector
Description

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

Returnosid.installation.DepotQueryInspectorthe depot query inspector
CompliancemandatoryThis 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.TypedepotSearchRecordTypea depot search record type
Returnosid.installation.records.DepotSearchResultsRecordthe depot search results record
ErrorsNULL_ARGUMENT depotSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(depotSearchRecordType) is false
CompliancemandatoryThis method must be implemented.