public interface AuctionProcessorEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve
AuctionProcessorEnabler
to AuctionProcessor
mappings. An AuctionProcessor
with multiple
AuctionProcessorEnablers
means any positive rule evaluation across
the enablers result in an effective AuctionProcessor.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAuctionProcessorEnablerRules()
Tests if this user can perform lookups of auction processor
enabler/auction processor mappings.
|
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
IdList |
getAuctionProcessorEnablerIdsForAuctionProcessor(Id auctionProcessorId)
Gets the
AuctionProcessorEnabler Id associated with an
AuctionProcessor. |
AuctionProcessorEnablerList |
getAuctionProcessorEnablersForAuctionProcessor(Id auctionProcessorId)
Gets the
AuctionProcessorEnabler associated with an
AuctionProcessor. |
IdList |
getAuctionProcessorIdsForAuctionProcessorEnabler(Id auctionProcessorEnablerId)
Gets the
AuctionProcessor Ids mapped to
an AuctionProcessorEnabler. |
AuctionProcessorList |
getAuctionProcessorsForAuctionProcessorEnabler(Id auctionProcessorEnablerId)
Gets the
AuctionProcessors mapped to an
AuctionProcessorEnabler. |
void |
useComparativeAuctionProcessorEnablerRuleView()
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 |
useFederatedAuctionHouseView()
Federates the view for methods in this session.
|
void |
useIsolatedAuctionHouseView()
Isolates the view for methods in this session.
|
void |
usePlenaryAuctionProcessorEnablerRuleView()
A complete view of the
AuctionProcessorEnabler and
AuctionProcessor returns is desired. |
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 canLookupAuctionProcessorEnablerRules()
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 useComparativeAuctionProcessorEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryAuctionProcessorEnablerRuleView()
AuctionProcessorEnabler
and
AuctionProcessor
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. void useFederatedAuctionHouseView()
mandatory
- This method is must be implemented. void useIsolatedAuctionHouseView()
mandatory
- This method is must be implemented. IdList getAuctionProcessorEnablerIdsForAuctionProcessor(Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessorEnabler Id
associated with an
AuctionProcessor.
auctionProcessorId
- Id
of the
AuctionProcessor
Ids
NotFoundException
- auctionProcessorId
is not foundNullArgumentException
- auctionProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionProcessorEnablerList getAuctionProcessorEnablersForAuctionProcessor(Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessorEnabler
associated with an
AuctionProcessor.
auctionProcessorId
- Id
of the
AuctionProcessor
NotFoundException
- auctionProcessorId
is not foundNullArgumentException
- auctionProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAuctionProcessorIdsForAuctionProcessorEnabler(Id auctionProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessor
Ids
mapped to
an AuctionProcessorEnabler.
auctionProcessorEnablerId
- Id
of an
AuctionProcessorEnabler
Ids
NotFoundException
- auctionProcessorEnablerId
is not foundNullArgumentException
-
auctionProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionProcessorList getAuctionProcessorsForAuctionProcessorEnabler(Id auctionProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessors
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.