Interface AuctionHouseSearchSession

All Superinterfaces:

AuctionHouseQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuctionHouseSearchSession
extends AuctionHouseQuerySession

This session provides methods for searching among AuctionHouses . The search query is constructed using the AuctionHouseQuery .

getAuctionHousesByQuery() is the basic search method and returns a list of Auction Houses . A more advanced search may be performed with getAuctionHousesBySearch() .It accepts an AuctionHouseSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuctionHousesBySearch() returns an AuctionHouseSearchResults that can be used to access the resulting AuctionHouseList or be used to perform a search within the result set through AuctionHouseSearch .

AuctionHouses may have a query record indicated by their respective record types. The query record is accessed via the AuctionHouseQuery .

Method Summary

Modifier and Type	Method	Description
AuctionHouseQuery	getAuctionHouseQueryFromInspector(AuctionHouseQueryInspector auctionHouseQueryInspector)	Gets an auction house query from an inspector.
AuctionHouseSearchResults	getAuctionHousesBySearch(AuctionHouseQuery auctionHouseQuery, AuctionHouseSearch auctionHouseSearch)	Gets the search results matching the given search query using the given search.
AuctionHouseSearch	getAuctionHouseSearch()	Gets an auction house search.
AuctionHouseSearchOrder	getAuctionHouseSearchOrder()	Gets an auction house search order.

Methods inherited from interface AuctionHouseQuerySession

canSearchAuctionHouses, getAuctionHouseQuery, getAuctionHousesByQuery

Modifier and Type	Method	Description
boolean	canSearchAuctionHouses()	Tests if this user can perform AuctionHouse searches.
AuctionHouseQuery	getAuctionHouseQuery()	Gets an auction house query.
AuctionHouseList	getAuctionHousesByQuery(AuctionHouseQuery auctionHouseQuery)	Gets a list of AuctionHouses matching the given search.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getAuctionHouseSearch

AuctionHouseSearch getAuctionHouseSearch()

Gets an auction house search.

Returns:

the auction house search

Compliance:

mandatory - This method must be implemented.

getAuctionHouseSearchOrder

AuctionHouseSearchOrder getAuctionHouseSearchOrder()

Gets an auction house search order. The AuctionHouseSearchOrder is supplied to an AuctionHouseSearch to specify the ordering of results.

Returns:

the auction house search order

Compliance:

mandatory - This method must be implemented.

getAuctionHousesBySearch

AuctionHouseSearchResults getAuctionHousesBySearch(AuctionHouseQuery auctionHouseQuery,
 AuctionHouseSearch auctionHouseSearch)
                                            throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

auctionHouseQuery - the auction house query

auctionHouseSearch - the auction house search

Returns:

the returned search results

Throws:

NullArgumentException - auctionHouseQuery or auctionHouseSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - auctionHouseQuery or auctionHouseSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAuctionHouseQueryFromInspector

AuctionHouseQuery getAuctionHouseQueryFromInspector(AuctionHouseQueryInspector auctionHouseQueryInspector)

Gets an auction house query from an inspector. The inspector is available from an AuctionHouseSearchResults .

Parameters:

auctionHouseQueryInspector - an auction house query inspector

Returns:

the auction house query

Throws:

NullArgumentException - auctionHouseQueryInspector is null

UnsupportedException - auctionHouseQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.