public interface AuctionProcessorSearchSession extends AuctionProcessorQuerySession
This session provides methods for searching among
AuctionProcessor
objects. The search query is constructed using
the AuctionProcessoryQuery.
getAuctionProcessorsByQuery()
is the basic search
method and returns a list of AuctionProcessors.
A more
advanced search may be performed with
getAuctionProcessorsBySearch().
It accepts an
AuctionProcessorSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
bidding. getAuctionProcessorsBySearch()
returns an
AuctionProcessorSearchResults
that can be used to access the
resulting AuctionProcessorList
or be used to perform a
search within the result set through AuctionProcessorSearch.
This session defines views that offer differing behaviors for searching.
AuctionProcessors
may have a query record indicated by
their respective record types. The query record is accessed via the
AuctionProcessorQuery.
Modifier and Type | Method and Description |
---|---|
AuctionProcessorQuery |
getAuctionProcessorQueryFromInspector(AuctionProcessorQueryInspector auctionProcessorQueryInspector)
Gets an auction processor query from an inspector.
|
AuctionProcessorSearchResults |
getAuctionProcessorsBySearch(AuctionProcessorQuery auctionProcessorQuery,
AuctionProcessorSearch auctionProcessorSearch)
Gets the search results matching the given search query using the
given search.
|
AuctionProcessorSearch |
getAuctionProcessorSearch()
Gets an auction processor search.
|
AuctionProcessorSearchOrder |
getAuctionProcessorSearchOrder()
Gets an auction processor search order.
|
canSearchAuctionProcessors, getAuctionHouse, getAuctionHouseId, getAuctionProcessorQuery, getAuctionProcessorsByQuery, useFederatedAuctionHouseView, useIsolatedAuctionHouseView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AuctionProcessorSearch getAuctionProcessorSearch()
mandatory
- This method must be implemented. AuctionProcessorSearchOrder getAuctionProcessorSearchOrder()
AuctionProcessorSearchOrder
is supplied to an
AuctionProcessorSearch
to specify the ordering of results.mandatory
- This method must be implemented. AuctionProcessorSearchResults getAuctionProcessorsBySearch(AuctionProcessorQuery auctionProcessorQuery, AuctionProcessorSearch auctionProcessorSearch) throws OperationFailedException, PermissionDeniedException
auctionProcessorQuery
- the auction processor queryauctionProcessorSearch
- the auction processor searchNullArgumentException
- auctionProcessorQuery
or auctionProcessorSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auctionProcessorQuery
or auctionProcessorSearch
is not of
this servicemandatory
- This method must be implemented. AuctionProcessorQuery getAuctionProcessorQueryFromInspector(AuctionProcessorQueryInspector auctionProcessorQueryInspector)
AuctionProcessorSearchResults.
auctionProcessorQueryInspector
- an auction processor query
inspectorNullArgumentException
-
auctionProcessorQueryInspector
is null
UnsupportedException
-
auctionProcessorQueryInspector
is not of this servicemandatory
- This method must be implemented.