| Interface | osid.resource.BinSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The interface for governing bin searches. | ||
| Method | searchAmongBins | ||
| Description |
Execute this search among the given list of bins. | ||
| Parameters | osid.id.IdList | binIds | list of bins |
| Errors | NULL_ARGUMENT | binIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBinResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.resource.BinSearchOrder | binSearchOrder | bin search order |
| Errors | NULL_ARGUMENT | binSearchOrder is null | |
| UNSUPPORTED | binSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getBinSearchRecord | ||
| Description |
Gets the bin search record corresponding to the given
bin search record | ||
| Parameters | osid.type.Type | binSearchRecordType | a bin search record type |
| Return | osid.resource.records.BinSearchRecord | the bin search record | |
| Errors | NULL_ARGUMENT | binSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(binSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |