OSID Logo
OSID Specifications
resource package
Version 3.1.0
Interfaceosid.resource.BinSearch
Implementsosid.OsidSearch
Used Byosid.resource.BinSearchSession
Description

The interface for governing bin searches.

MethodsearchAmongBins
Description

Execute this search among the given list of bins.

Parametersosid.id.IdListbinIds list of bins
ErrorsNULL_ARGUMENT binIds is null
Compliancemandatory This method must be implemented.
MethodorderBinResults
Description

Specify an ordering to the search results.

Parametersosid.resource.BinSearchOrderbinSearchOrder bin search order
ErrorsNULL_ARGUMENT binSearchOrder is null
UNSUPPORTED binSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetBinSearchRecord
Description

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