public interface AuctionProcessorQuerySession extends OsidSession
This session provides methods for searching among
AuctionProcessor
objects. The search query is constructed using
the AuctionProcessorQuery.
This session defines views that offer differing behaviors for searching.
Auction processor may have a query record indicated by their
respective record types. The record is accessed via the
AuctionProcessorQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAuctionProcessors()
Tests if this user can perform
AuctionProcessor
lookups. |
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
AuctionProcessorQuery |
getAuctionProcessorQuery()
Gets an auction processor query.
|
AuctionProcessorList |
getAuctionProcessorsByQuery(AuctionProcessorQuery auctionProcessorQuery)
Gets a list of
AuctionProcessors matching the given
search. |
void |
useFederatedAuctionHouseView()
Federates the view for methods in this session.
|
void |
useIsolatedAuctionHouseView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAuctionHouseId()
AuctionHouse
Id
associated with
this session. AuctionHouse Id
associated with this
sessionmandatory
- This method must be implemented. AuctionHouse getAuctionHouse() throws OperationFailedException, PermissionDeniedException
AuctionHouse
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchAuctionProcessors()
AuctionProcessor
lookups. A return of true does not guarantee successful authorization.
A return of false indicates that it is known all methods in this
session will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may not offer lookup
operations to unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedAuctionHouseView()
mandatory
- This method is must be implemented. void useIsolatedAuctionHouseView()
mandatory
- This method is must be implemented. AuctionProcessorQuery getAuctionProcessorQuery()
mandatory
- This method must be implemented. AuctionProcessorList getAuctionProcessorsByQuery(AuctionProcessorQuery auctionProcessorQuery) throws OperationFailedException, PermissionDeniedException
AuctionProcessors
matching the given
search.auctionProcessorQuery
- the auction processor query AuctionProcessorList
NullArgumentException
- auctionProcessorQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auctionProcessorQuery
is not of this servicemandatory
- This method must be implemented.