Interface AuctionConstrainerEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AuctionConstrainerEnablerSearch
extends OsidSearch

The search interface for governing auction constrainer enabler searches.

Method Summary

Modifier and Type	Method	Description
AuctionConstrainerEnablerSearchRecord	getAuctionConstrainerEnablerSearchRecord(Type auctionConstrainerEnablerSearchRecordType)	Gets the auction constrainer enabler search record corresponding to the given auction constrainer enabler search record Type.
void	orderAuctionConstrainerEnablerResults(AuctionConstrainerEnablerSearchOrder auctionConstrainerEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongAuctionConstrainerEnablers(IdList auctionConstrainerEnablerIds)	Execute this search among the given list of auction constrainer 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

searchAmongAuctionConstrainerEnablers

void searchAmongAuctionConstrainerEnablers(IdList auctionConstrainerEnablerIds)

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

Parameters:

auctionConstrainerEnablerIds - list of auction constrainer enablers

Throws:

NullArgumentException - auctionConstrainerEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderAuctionConstrainerEnablerResults

void orderAuctionConstrainerEnablerResults(AuctionConstrainerEnablerSearchOrder auctionConstrainerEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

auctionConstrainerEnablerSearchOrder - auction constrainer enabler search order

Throws:

NullArgumentException - auctionConstrainerEnablerSearchOrder is null

UnsupportedException - auctionConstrainerEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainerEnablerSearchRecord

AuctionConstrainerEnablerSearchRecord getAuctionConstrainerEnablerSearchRecord(Type auctionConstrainerEnablerSearchRecordType)
                                                                        throws OperationFailedException

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

Parameters:

auctionConstrainerEnablerSearchRecordType - an auction constrainer enabler search record type

Returns:

the auction constrainer enabler search record

Throws:

NullArgumentException - auctionConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.