OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.BinSearch
Implementsosid.OsidSearch
Description

The interface for governing bin searches.

MethodsearchAmongBins
Description

Execute this search among the given list of bins.

Parametersosid.id.IdListbinIdslist of bins
ErrorsNULL_ARGUMENT binIds is null
CompliancemandatoryThis method must be implemented.
MethodorderBinResults
Description

Specify an ordering to the search results.

Parametersosid.resource.BinSearchOrderbinSearchOrderbin search order
ErrorsNULL_ARGUMENT binSearchOrder is null
UNSUPPORTED binSearchOrder is not of this service
CompliancemandatoryThis 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.TypebinSearchRecordTypea bin search record type
Returnosid.resource.records.BinSearchRecordthe bin search record
ErrorsNULL_ARGUMENT binSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(binSearchRecordType) is false
CompliancemandatoryThis method must be implemented.