public interface AuctionProcessorRuleLookupSession extends OsidSession
This session provides methods to retrieve AuctionProcessor
to Auction
mappings.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAuctionProcessorRules()
Tests if this user can perform lookups of auction processor/auction
mappings.
|
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
IdList |
getAuctionIdsForAuctionProcessor(Id auctionProcessorId)
Gets the
Auction Ids mapped to an
AuctionProcessor. |
IdList |
getAuctionProcessorIdsForAuction(Id auctionId)
Gets the
AuctionProcessor Id associated with an
Auction. |
AuctionProcessorList |
getAuctionProcessorsForAuction(Id auctionId)
Gets the
AuctionProcessor associated with an
Auction. |
AuctionList |
getAuctionsForAuctionProcessor(Id auctionProcessorId)
Gets the
Auctions mapped to an AuctionProcessor. |
void |
useComparativeAuctionProcessorRuleView()
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 |
usePlenaryAuctionProcessorRuleView()
A complete view of the
AuctionProcessor and
Auction 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 canLookupAuctionProcessorRules()
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 useComparativeAuctionProcessorRuleView()
mandatory
- This method is must be implemented. void usePlenaryAuctionProcessorRuleView()
AuctionProcessor
and
Auction
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 getAuctionProcessorIdsForAuction(Id auctionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessor Id
associated with an
Auction.
auctionId
- Id
of the Auction
Ids
NotFoundException
- auctionId
is not
foundNullArgumentException
- auctionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionProcessorList getAuctionProcessorsForAuction(Id auctionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessor
associated with an
Auction.
auctionId
- Id
of the Auction
NotFoundException
- auctionId
is not
foundNullArgumentException
- auctionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAuctionIdsForAuctionProcessor(Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Auction
Ids
mapped to an
AuctionProcessor.
auctionProcessorId
- Id
of an
AuctionProcessor
Ids
NotFoundException
- auctionProcessorId
is not foundNullArgumentException
- auctionProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionList getAuctionsForAuctionProcessor(Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Auctions
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.