org.osid.bidding

Interface AuctionSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AuctionSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

Modifier and Type	Method and Description
AuctionQueryInspector	getAuctionQueryInspector() Gets the inspector for the query to examine the terms used in the search.
AuctionList	getAuctions() Gets the auction list resulting from a search.
AuctionSearchResultsRecord	getAuctionSearchResultsRecord(Type auctionSearchRecordType) Gets the auction search results record corresponding to the given auction search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getAuctions

AuctionList getAuctions()

Gets the auction list resulting from a search.

Returns:

the auction list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getAuctionQueryInspector

AuctionQueryInspector getAuctionQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the auction query inspector

Compliance:

mandatory - This method must be implemented.

getAuctionSearchResultsRecord

AuctionSearchResultsRecord getAuctionSearchResultsRecord(Type auctionSearchRecordType)
                                                         throws OperationFailedException

Gets the auction search results 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 results record

Throws:

NullArgumentException - auctionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.