Interface AuctionHouseSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AuctionHouseSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AuctionHouseQueryInspector	getAuctionHouseQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AuctionHouseList	getAuctionHouses()	Gets the auction house list resulting from a search.
AuctionHouseSearchResultsRecord	getAuctionHouseSearchResultsRecord(Type auctionHouseSearchRecordType)	Gets the auction houses search results record corresponding to the given auction house 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

getAuctionHouses

AuctionHouseList getAuctionHouses()

Gets the auction house list resulting from a search.

Returns:

the auction house list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getAuctionHouseQueryInspector

AuctionHouseQueryInspector getAuctionHouseQueryInspector()

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

Returns:

the auction house query inspector

Compliance:

mandatory - This method must be implemented.

getAuctionHouseSearchResultsRecord

AuctionHouseSearchResultsRecord getAuctionHouseSearchResultsRecord(Type auctionHouseSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

auctionHouseSearchRecordType - an auction house search record type

Returns:

the auction house search results record

Throws:

NullArgumentException - auctionHouseSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionHouseSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.