OSID Logo
OSID Specifications
resource package
Version 3.1.0
Interfaceosid.resource.BinSearchResults
Implementsosid.OsidSearchResults
Used Byosid.resource.BinSearchSession
Description

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

MethodgetBins
Description

Gets the bin list resulting from the search.

Returnosid.resource.BinList the bin list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetBinQueryInspector
Description

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

Returnosid.resource.BinQueryInspector the bin query inspector
Compliancemandatory This method must be implemented.
MethodgetBinSearchResultsRecord
Description

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

Parametersosid.type.TypebinSearchRecordType a bin search record type
Returnosid.resource.records.BinSearchResultsRecord the bin search results record
ErrorsNULL_ARGUMENT binSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(binSearchRecordType) is false
Compliancemandatory This method must be implemented.