Interface AuctionSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AuctionSearch
extends OsidSearch

The search interface for governing auction searches.

Method Summary

Modifier and Type	Method	Description
AuctionSearchRecord	getAuctionSearchRecord(Type auctionSearchRecordType)	Gets the auction search record corresponding to the given auction search record Type.
void	orderAuctionResults(AuctionSearchOrder auctionSearchOrder)	Specify an ordering to the search results.
void	searchAmongAuctions(IdList auctionIds)	Execute this search among the given list of auctions.

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

searchAmongAuctions

void searchAmongAuctions(IdList auctionIds)

Execute this search among the given list of auctions.

Parameters:

auctionIds - list of auctions

Throws:

NullArgumentException - auctionIds is null

Compliance:

mandatory - This method must be implemented.

orderAuctionResults

void orderAuctionResults(AuctionSearchOrder auctionSearchOrder)

Specify an ordering to the search results.

Parameters:

auctionSearchOrder - auction search order

Throws:

NullArgumentException - auctionSearchOrder is null

UnsupportedException - auctionSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAuctionSearchRecord

AuctionSearchRecord getAuctionSearchRecord(Type auctionSearchRecordType)
                                    throws OperationFailedException

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

Parameters:

auctionSearchRecordType - an auction search record type

Returns:

the auction search record

Throws:

NullArgumentException - auctionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.