Interface AuctionProcessorEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AuctionProcessorEnablerSearch
extends OsidSearch

The search interface for governing auction processor enabler searches.

Method Summary

Modifier and Type	Method	Description
AuctionProcessorEnablerSearchRecord	getAuctionProcessorEnablerSearchRecord(Type auctionProcessorEnablerSearchRecordType)	Gets the auction processor enabler search record corresponding to the given auction processor enabler search record Type.
void	orderAuctionProcessorEnablerResults(AuctionProcessorEnablerSearchOrder auctionProcessorEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongAuctionProcessorEnablers(IdList auctionProcessorEnablerIds)	Execute this search among the given list of auction processor 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

searchAmongAuctionProcessorEnablers

void searchAmongAuctionProcessorEnablers(IdList auctionProcessorEnablerIds)

Execute this search among the given list of auction processor enablers.

Parameters:

auctionProcessorEnablerIds - list of auction processor enablers

Throws:

NullArgumentException - auctionProcessorEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderAuctionProcessorEnablerResults

void orderAuctionProcessorEnablerResults(AuctionProcessorEnablerSearchOrder auctionProcessorEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

auctionProcessorEnablerSearchOrder - auction processor enabler search order

Throws:

NullArgumentException - auctionProcessorEnablerSearchOrder is null

UnsupportedException - auctionProcessorEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAuctionProcessorEnablerSearchRecord

AuctionProcessorEnablerSearchRecord getAuctionProcessorEnablerSearchRecord(Type auctionProcessorEnablerSearchRecordType)
                                                                    throws OperationFailedException

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

Parameters:

auctionProcessorEnablerSearchRecordType - an auction processor enabler search record type

Returns:

the auction processor enabler search record

Throws:

NullArgumentException - auctionProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.