public interface BidAuctionHouseSession extends OsidSession
This session provides methods to retrieve Bid
to
AuctionHouse
mappings. A Bid
may appear in multiple
AuctionHouse
objects. Each auction house may have its own
authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupBidAuctionHouseMappings()
Tests if this user can perform lookups of bid/auction house mappings.
|
IdList |
getAuctionHouseIdsByBid(Id bidId)
Gets the
AuctionHouse Ids mapped to a
Bid. |
AuctionHouseList |
getAuctionHousesByBid(Id bidId)
Gets the
AuctionHouses mapped to a Bid. |
IdList |
getBidIdsByAuctionHouse(Id auctionHouseId)
Gets the list of
Bid Ids associated with an
AuctionHouse. |
IdList |
getBidIdsByAuctionHouses(IdList auctionHouseIds)
Gets the list of
Bid Ids corresponding to a list of
AuctionHouses. |
BidList |
getBidsByAuctionHouse(Id auctionHouseId)
Gets the list of
Bids associated with an
AuctionHouse. |
BidList |
getBidsByAuctionHouses(IdList auctionHouseIds)
Gets the list of
Bid corresponding to a list of
AuctionHouses. |
void |
useComparativeBidAuctionHouseView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryBidAuctionHouseView()
A complete view of the
Bid and AuctionHouse
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupBidAuctionHouseMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeBidAuctionHouseView()
mandatory
- This method is must be implemented. void usePlenaryBidAuctionHouseView()
Bid
and AuctionHouse
returns is desired. Methods will return what is requested or
result in an error. This view is used when greater precision is
desired at the expense of interoperability.mandatory
- This method is must be implemented. IdList getBidIdsByAuctionHouse(Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bid Ids
associated with an
AuctionHouse.
auctionHouseId
- Id
of the AuctionHouse
Ids
NotFoundException
- auctionHouseId
is
not foundNullArgumentException
- auctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getBidsByAuctionHouse(Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bids
associated with an
AuctionHouse.
auctionHouseId
- Id
of the AuctionHouse
NotFoundException
- auctionHouseId
is
not foundNullArgumentException
- auctionHouseId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBidIdsByAuctionHouses(IdList auctionHouseIds) throws OperationFailedException, PermissionDeniedException
Bid Ids
corresponding to a list of
AuctionHouses.
auctionHouseIds
- list of auction house Ids
Ids
NullArgumentException
- auctionHouseIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BidList getBidsByAuctionHouses(IdList auctionHouseIds) throws OperationFailedException, PermissionDeniedException
Bid
corresponding to a list of
AuctionHouses.
auctionHouseIds
- list of auction house Ids
NullArgumentException
- auctionHouseIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAuctionHouseIdsByBid(Id bidId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionHouse
Ids
mapped to a
Bid.
bidId
- Id
of a Bid
NotFoundException
- bidId
is not foundNullArgumentException
- bidId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionHouseList getAuctionHousesByBid(Id bidId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionHouses
mapped to a Bid.
bidId
- Id
of a Bid
NotFoundException
- bidId
is not foundNullArgumentException
- bidId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.