public interface AuctionConstrainerSearchSession extends AuctionConstrainerQuerySession
This session provides methods for searching among
AuctionConstrainer
objects. The search query is constructed using
the AuctionConstraineryQuery.
getAuctionConstrainersByQuery()
is the basic search
method and returns a list of AuctionConstrainers.
A more
advanced search may be performed with
getAuctionConstrainersBySearch().
It accepts an
AuctionConstrainerSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
bidding. getAuctionConstrainersBySearch()
returns an
AuctionConstrainerSearchResults
that can be used to access the
resulting AuctionConstrainerList
or be used to perform a
search within the result set through AuctionConstrainerSearch.
This session defines views that offer differing behaviors for searching.
AuctionConstrainers
may have a query record indicated
by their respective record types. The query record is accessed via the
AuctionConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
AuctionConstrainerQuery |
getAuctionConstrainerQueryFromInspector(AuctionConstrainerQueryInspector auctionConstrainerQueryInspector)
Gets an auction constrainer query from an inspector.
|
AuctionConstrainerSearchResults |
getAuctionConstrainersBySearch(AuctionConstrainerQuery auctionConstrainerQuery,
AuctionConstrainerSearch auctionConstrainerSearch)
Gets the search results matching the given search query using the
given search.
|
AuctionConstrainerSearch |
getAuctionConstrainerSearch()
Gets an auction constrainer search.
|
AuctionConstrainerSearchOrder |
getAuctionConstrainerSearchOrder()
Gets an auction constrainer search order.
|
canSearchAuctionConstrainers, getAuctionConstrainerQuery, getAuctionConstrainersByQuery, getAuctionHouse, getAuctionHouseId, useFederatedAuctionHouseView, useIsolatedAuctionHouseView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AuctionConstrainerSearch getAuctionConstrainerSearch()
mandatory
- This method must be implemented. AuctionConstrainerSearchOrder getAuctionConstrainerSearchOrder()
AuctionConstrainerSearchOrder
is supplied to an
AuctionConstrainerSearch
to specify the ordering of results.mandatory
- This method must be implemented. AuctionConstrainerSearchResults getAuctionConstrainersBySearch(AuctionConstrainerQuery auctionConstrainerQuery, AuctionConstrainerSearch auctionConstrainerSearch) throws OperationFailedException, PermissionDeniedException
auctionConstrainerQuery
- the auction constrainer queryauctionConstrainerSearch
- the auction constrainer searchNullArgumentException
- auctionConstrainerQuery
or auctionConstrainerSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auctionConstrainerQuery
or auctionConstrainerSearch
is not of
this servicemandatory
- This method must be implemented. AuctionConstrainerQuery getAuctionConstrainerQueryFromInspector(AuctionConstrainerQueryInspector auctionConstrainerQueryInspector)
AuctionConstrainerSearchResults.
auctionConstrainerQueryInspector
- an auction constrainer query
inspectorNullArgumentException
-
auctionConstrainerQueryInspector
is null
UnsupportedException
-
auctionConstrainerQueryInspector
is not of this
servicemandatory
- This method must be implemented.