public interface AuctionProcessorEnablerAuctionHouseSession extends OsidSession
This session provides methods to retrieve
AuctionProcessorEnabler
to AuctionHouse
mappings.
An AuctionProcessorEnabler
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 |
canLookupAuctionProcessorEnablerAuctionHouseMappings()
Tests if this user can perform lookups of auction processor
enabler/auction house mappings.
|
IdList |
getAuctionHouseIdsByAuctionProcessorEnabler(Id auctionProcessorEnablerId)
Gets the
AuctionHouse Ids mapped to an
AuctionProcessorEnabler. |
AuctionHouseList |
getAuctionHousesByAuctionProcessorEnabler(Id auctionProcessorEnablerId)
Gets the
AuctionHouses mapped to an
AuctionProcessorEnabler. |
IdList |
getAuctionProcessorEnablerIdsByAuctionHouse(Id auctionHouseId)
Gets the list of
AuctionProcessorEnablerIds associated
with an AuctionHouse. |
IdList |
getAuctionProcessorEnablerIdsByAuctionHouses(IdList auctionHouseIds)
Gets the list of
AuctionProcessorEnabler Ids
corresponding to a list of AuctionHouses. |
AuctionProcessorEnablerList |
getAuctionProcessorEnablersByAuctionHouse(Id auctionHouseId)
Gets the list of auction processor enablers associated with an
AuctionHouse. |
AuctionProcessorEnablerList |
getAuctionProcessorEnablersByAuctionHouses(IdList auctionHouseIds)
Gets the list of auction processor enablers corresponding to a list of
AuctionHouses. |
void |
useComparativeAuctionProcessorEnablerAuctionHouseView()
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 |
usePlenaryAuctionProcessorEnablerAuctionHouseView()
A complete view of the
AuctionProcessorEnabler and
AuctionHouse returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupAuctionProcessorEnablerAuctionHouseMappings()
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 useComparativeAuctionProcessorEnablerAuctionHouseView()
mandatory
- This method is must be implemented. void usePlenaryAuctionProcessorEnablerAuctionHouseView()
AuctionProcessorEnabler
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 getAuctionProcessorEnablerIdsByAuctionHouse(Id auctionHouseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessorEnablerIds
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. AuctionProcessorEnablerList getAuctionProcessorEnablersByAuctionHouse(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 getAuctionProcessorEnablerIdsByAuctionHouses(IdList auctionHouseIds) throws OperationFailedException, PermissionDeniedException
AuctionProcessorEnabler 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. AuctionProcessorEnablerList getAuctionProcessorEnablersByAuctionHouses(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 getAuctionHouseIdsByAuctionProcessorEnabler(Id auctionProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionHouse
Ids
mapped to an
AuctionProcessorEnabler.
auctionProcessorEnablerId
- Id
of an
AuctionProcessorEnabler
NotFoundException
- auctionProcessorEnablerId
is not foundNullArgumentException
-
auctionProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionHouseList getAuctionHousesByAuctionProcessorEnabler(Id auctionProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionHouses
mapped to an
AuctionProcessorEnabler.
auctionProcessorEnablerId
- Id
of an
AuctionProcessorEnabler
NotFoundException
- auctionProcessorEnablerId
is not foundNullArgumentException
-
auctionProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.