public interface AuctionConstrainerQuerySession extends OsidSession
This session provides methods for searching among
AuctionConstrainer
objects. The search query is constructed using
the AuctionConstrainerQuery.
This session defines views that offer differing behaviors for searching.
Auction constrainer 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 |
---|---|
boolean |
canSearchAuctionConstrainers()
Tests if this user can perform
AuctionConstrainer
lookups. |
AuctionConstrainerQuery |
getAuctionConstrainerQuery()
Gets an auction constrainer query.
|
AuctionConstrainerList |
getAuctionConstrainersByQuery(AuctionConstrainerQuery auctionConstrainerQuery)
Gets a list of
AuctionConstrainers matching the given
search. |
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
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 canSearchAuctionConstrainers()
AuctionConstrainer
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. AuctionConstrainerQuery getAuctionConstrainerQuery()
mandatory
- This method must be implemented. AuctionConstrainerList getAuctionConstrainersByQuery(AuctionConstrainerQuery auctionConstrainerQuery) throws OperationFailedException, PermissionDeniedException
AuctionConstrainers
matching the given
search.auctionConstrainerQuery
- the auction constrainer query AuctionConstrainerList
NullArgumentException
- auctionConstrainerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auctionConstrainerQuery
is not of this servicemandatory
- This method must be implemented.