public interface AuctionProcessorAuctionHouseSession extends OsidSession
This session provides methods to retrieve AuctionProcessor
to AuctionHouse
mappings. An
AuctionProcessor
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 |
canLookupAuctionProcessorAuctionHouseMappings()
Tests if this user can perform lookups of auction processor/auction
house mappings.
|
IdList |
getAuctionHouseIdsByAuctionProcessor(Id auctionProcessorId)
Gets the
AuctionHouse Ids mapped to an
AuctionProcessor. |
AuctionHouseList |
getAuctionHousesByAuctionProcessor(Id auctionProcessorId)
Gets the
AuctionHouses mapped to an
AuctionProcessor. |
IdList |
getAuctionProcessorIdsByAuctionHouse(Id auctionHouseId)
Gets the list of
AuctionProcessorIds associated with an
AuctionHouse. |
IdList |
getAuctionProcessorIdsByAuctionHouses(IdList auctionHouseIds)
Gets the list of
AuctionProcessor Ids corresponding to
a list of AuctionHouses. |
AuctionProcessorList |
getAuctionProcessorsByAuctionHouse(Id auctionHouseId)
Gets the list of auction processors associated with an
AuctionHouse. |
AuctionProcessorList |
getAuctionProcessorsByAuctionHouses(IdList auctionHouseIds)
Gets the list of auction processor corresponding to a list of
AuctionHouses. |
void |
useComparativeAuctionProcessorAuctionHouseView()
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 |
usePlenaryAuctionProcessorAuctionHouseView()
A complete view of the
AuctionProcessor and
AuctionHouse returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupAuctionProcessorAuctionHouseMappings()
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 useComparativeAuctionProcessorAuctionHouseView()
mandatory
- This method is must be implemented. void usePlenaryAuctionProcessorAuctionHouseView()
AuctionProcessor
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 getAuctionProcessorIdsByAuctionHouse(Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessorIds
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. AuctionProcessorList getAuctionProcessorsByAuctionHouse(Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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 getAuctionProcessorIdsByAuctionHouses(IdList auctionHouseIds) throws OperationFailedException, PermissionDeniedException
AuctionProcessor 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. AuctionProcessorList getAuctionProcessorsByAuctionHouses(IdList auctionHouseIds) throws OperationFailedException, PermissionDeniedException
AuctionHouses.
auctionHouseIds
- list of auction house Ids
NullArgumentException
- auctionHouseIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAuctionHouseIdsByAuctionProcessor(Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionHouse
Ids
mapped to an
AuctionProcessor.
auctionProcessorId
- Id
of an
AuctionProcessor
NotFoundException
- auctionProcessorId
is not foundNullArgumentException
- auctionProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionHouseList getAuctionHousesByAuctionProcessor(Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionHouses
mapped to an
AuctionProcessor.
auctionProcessorId
- Id
of an
AuctionProcessor
NotFoundException
- auctionProcessorId
is not foundNullArgumentException
- auctionProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.