Interface BidEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BidEnablerSearch
extends OsidSearch

The search interface for governing bid enabler searches.

Method Summary

Modifier and Type	Method	Description
BidEnablerSearchRecord	getBidEnablerSearchRecord(Type bidEnablerSearchRecordType)	Gets the bid enabler search record corresponding to the given bid enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderBidEnablerResults(BidEnablerSearchOrder bidEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongBidEnablers(IdList bidEnablerIds)	Execute this search among the given list of bid enablers.

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

searchAmongBidEnablers

void searchAmongBidEnablers(IdList bidEnablerIds)

Execute this search among the given list of bid enablers.

Parameters:

bidEnablerIds - list of bid enablers

Throws:

NullArgumentException - bidEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderBidEnablerResults

void orderBidEnablerResults(BidEnablerSearchOrder bidEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

bidEnablerSearchOrder - bid enabler search order

Throws:

NullArgumentException - bidEnablerSearchOrder is null

UnsupportedException - bidEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBidEnablerSearchRecord

BidEnablerSearchRecord getBidEnablerSearchRecord(Type bidEnablerSearchRecordType)
                                          throws OperationFailedException

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

Parameters:

bidEnablerSearchRecordType - a bid enabler search record type

Returns:

the bid enabler search record

Throws:

NullArgumentException - bidEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bidEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.