public interface AuctionHouseSearchSession extends AuctionHouseQuerySession
This session provides methods for searching among AuctionHouse
objects. 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.
Modifier and Type | Method and 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.
|
canSearchAuctionHouses, getAuctionHouseQuery, getAuctionHousesByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AuctionHouseSearch getAuctionHouseSearch()
mandatory
- This method must be implemented. AuctionHouseSearchOrder getAuctionHouseSearchOrder()
AuctionHouseSearchOrder
is supplied to an AuctionHouseSearch
to specify
the ordering of results.mandatory
- This method must be implemented. AuctionHouseSearchResults getAuctionHousesBySearch(AuctionHouseQuery auctionHouseQuery, AuctionHouseSearch auctionHouseSearch) throws OperationFailedException, PermissionDeniedException
auctionHouseQuery
- the auction house queryauctionHouseSearch
- the auction house searchNullArgumentException
- auctionHouseQuery
or auctionHouseSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auctionHouseQuery
or auctionHouseSearch
is not of this servicemandatory
- This method must be implemented. AuctionHouseQuery getAuctionHouseQueryFromInspector(AuctionHouseQueryInspector auctionHouseQueryInspector)
AuctionHouseSearchResults.
auctionHouseQueryInspector
- an auction house query inspectorNullArgumentException
-
auctionHouseQueryInspector
is null
UnsupportedException
-
auctionHouseQueryInspector
is not of this servicemandatory
- This method must be implemented.