Interface BidSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BidSearch
extends OsidSearch

The search interface for governing bid searches.

Method Summary

Modifier and Type	Method	Description
BidSearchRecord	getBidSearchRecord(Type bidSearchRecordType)	Gets the bid search record corresponding to the given bid search record Type .
void	orderBidResults(BidSearchOrder bidSearchOrder)	Specify an ordering to the search results.
void	searchAmongBids(IdList bidIds)	Execute this search among the given list of bids.

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

searchAmongBids

void searchAmongBids(IdList bidIds)

Execute this search among the given list of bids.

Parameters:

bidIds - list of bids

Throws:

NullArgumentException - bidIds is null

Compliance:

mandatory - This method must be implemented.

orderBidResults

void orderBidResults(BidSearchOrder bidSearchOrder)

Specify an ordering to the search results.

Parameters:

bidSearchOrder - bid search order

Throws:

NullArgumentException - bidSearchOrder is null

UnsupportedException - bidSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBidSearchRecord

BidSearchRecord getBidSearchRecord(Type bidSearchRecordType)
                            throws OperationFailedException

Gets the bid search record corresponding to the given bid search record Type . This method is used to retrieve an object implementing the requested record.

Parameters:

bidSearchRecordType - a bid search record type

Returns:

the bid search record

Throws:

NullArgumentException - bidSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bidSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.