Interface AuctionConstrainerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AuctionConstrainerSearch
extends OsidSearch

The search interface for governing auction constrainer searches.

Method Summary

Modifier and Type	Method	Description
AuctionConstrainerSearchRecord	getAuctionConstrainerSearchRecord(Type auctionConstrainerSearchRecordType)	Gets the auction constrainer search record corresponding to the given auction constrainer search record Type.
void	orderAuctionConstrainerResults(AuctionConstrainerSearchOrder auctionConstrainerSearchOrder)	Specify an ordering to the search results.
void	searchAmongAuctionConstrainers(IdList auctionConstrainerIds)	Execute this search among the given list of auction constrainers.

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

searchAmongAuctionConstrainers

void searchAmongAuctionConstrainers(IdList auctionConstrainerIds)

Execute this search among the given list of auction constrainers.

Parameters:

auctionConstrainerIds - list of auction constrainers

Throws:

NullArgumentException - auctionConstrainerIds is null

Compliance:

mandatory - This method must be implemented.

orderAuctionConstrainerResults

void orderAuctionConstrainerResults(AuctionConstrainerSearchOrder auctionConstrainerSearchOrder)

Specify an ordering to the search results.

Parameters:

auctionConstrainerSearchOrder - auction constrainer search order

Throws:

NullArgumentException - auctionConstrainerSearchOrder is null

UnsupportedException - auctionConstrainerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainerSearchRecord

AuctionConstrainerSearchRecord getAuctionConstrainerSearchRecord(Type auctionConstrainerSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

auctionConstrainerSearchRecordType - an auction constrainer search record type

Returns:

the auction constrainer search record

Throws:

NullArgumentException - auctionConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.