public interface BinSearch extends OsidSearch
The interface for governing bin searches.
Modifier and Type | Method and Description |
---|---|
BinSearchRecord |
getBinSearchRecord(Type binSearchRecordType)
Gets the bin search record corresponding to the given bin search
record
Type. |
void |
orderBinResults(BinSearchOrder binSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongBins(IdList binIds)
Execute this search among the given list of bins.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongBins(IdList binIds)
binIds
- list of binsNullArgumentException
- binIds
is
null
mandatory
- This method must be implemented. void orderBinResults(BinSearchOrder binSearchOrder)
binSearchOrder
- bin search orderNullArgumentException
- binSearchOrder
is null
UnsupportedException
- binSearchOrder
is
not of this servicemandatory
- This method must be implemented. BinSearchRecord getBinSearchRecord(Type binSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.binSearchRecordType
- a bin search record typeNullArgumentException
- binSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(binSearchRecordType)
is false
mandatory
- This method must be implemented.