OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.BinSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetBins
Description

Gets the bin list resulting from the search.

Returnosid.resource.BinListthe bin list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetBinQueryInspector
Description

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

Returnosid.resource.BinQueryInspectorthe bin query inspector
CompliancemandatoryThis 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.TypebinSearchRecordTypea bin search record type
Returnosid.resource.records.BinSearchResultsRecordthe bin search results record
ErrorsNULL_ARGUMENT binSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(binSearchRecordType) is false
CompliancemandatoryThis method must be implemented.