Interface AuctionProcessorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AuctionProcessorSearch
extends OsidSearch

The search interface for governing auction processor searches.

Method Summary

Modifier and Type	Method	Description
AuctionProcessorSearchRecord	getAuctionProcessorSearchRecord(Type auctionProcessorSearchRecordType)	Gets the auction processor search record corresponding to the given auction processor search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAuctionProcessorResults(AuctionProcessorSearchOrder auctionProcessorSearchOrder)	Specify an ordering to the search results.
void	searchAmongAuctionProcessors(IdList auctionProcessorIds)	Execute this search among the given list of auction processors.

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

searchAmongAuctionProcessors

void searchAmongAuctionProcessors(IdList auctionProcessorIds)

Execute this search among the given list of auction processors.

Parameters:

auctionProcessorIds - list of auction processors

Throws:

NullArgumentException - auctionProcessorIds is null

Compliance:

mandatory - This method must be implemented.

orderAuctionProcessorResults

void orderAuctionProcessorResults(AuctionProcessorSearchOrder auctionProcessorSearchOrder)

Specify an ordering to the search results.

Parameters:

auctionProcessorSearchOrder - auction processor search order

Throws:

NullArgumentException - auctionProcessorSearchOrder is null

UnsupportedException - auctionProcessorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAuctionProcessorSearchRecord

AuctionProcessorSearchRecord getAuctionProcessorSearchRecord(Type auctionProcessorSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

auctionProcessorSearchRecordType - an auction processor search record type

Returns:

the auction processor search record

Throws:

NullArgumentException - auctionProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.