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

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

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.