Interface BinSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BinSearch
extends OsidSearch

The interface for governing bin searches.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongBins

void searchAmongBins(IdList binIds)

Execute this search among the given list of bins.

Parameters:

binIds - list of bins

Throws:

NullArgumentException - binIds is null

Compliance:

mandatory - This method must be implemented.

orderBinResults

void orderBinResults(BinSearchOrder binSearchOrder)

Specify an ordering to the search results.

Parameters:

binSearchOrder - bin search order

Throws:

NullArgumentException - binSearchOrder is null

UnsupportedException - binSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBinSearchRecord

BinSearchRecord getBinSearchRecord(Type binSearchRecordType)
                            throws OperationFailedException

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.

Parameters:

binSearchRecordType - a bin search record type

Returns:

the bin search record

Throws:

NullArgumentException - binSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(binSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.