public interface AuctionConstrainerRuleLookupSession extends OsidSession
This session provides methods to retrieve AuctionConstrainer
to Auction
mappings. An Auction
with
multiple AuctionConstrainers
means any positive rule
evaluation across the result in an effective Auction.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAuctionConstrainerRules()
Tests if this user can perform lookups of auction constrainer/auction
mappings.
|
IdList |
getAuctionConstrainerIdsForAuction(Id auctionId)
Gets the
AuctionConstrainer Id associated with an
Auction. |
AuctionConstrainerList |
getAuctionConstrainersForAuction(Id auctionId)
Gets the
AuctionConstrainer associated with an
Auction. |
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
IdList |
getAuctionIdsForAuctionConstrainer(Id auctionConstrainerId)
Gets the
Auction Ids mapped to an
AuctionConstrainer. |
AuctionList |
getAuctionsForAuctionConstrainer(Id auctionConstrainerId)
Gets the
Auctions mapped to an
AuctionConstrainer. |
void |
useComparativeAuctionConstrainerRuleView()
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 |
usePlenaryAuctionConstrainerRuleView()
A complete view of the
AuctionConstrainer 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 canLookupAuctionConstrainerRules()
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 useComparativeAuctionConstrainerRuleView()
mandatory
- This method is must be implemented. void usePlenaryAuctionConstrainerRuleView()
AuctionConstrainer
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 getAuctionConstrainerIdsForAuction(Id auctionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainer 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. AuctionConstrainerList getAuctionConstrainersForAuction(Id auctionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainer
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 getAuctionIdsForAuctionConstrainer(Id auctionConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Auction
Ids
mapped to an
AuctionConstrainer.
auctionConstrainerId
- Id
of an
AuctionConstrainer
Ids
NotFoundException
- auctionConstrainerId
is not foundNullArgumentException
- auctionConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionList getAuctionsForAuctionConstrainer(Id auctionConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Auctions
mapped to an
AuctionConstrainer.
auctionConstrainerId
- Id
of an
AuctionConstrainer
NotFoundException
- auctionConstrainerId
is not foundNullArgumentException
- auctionConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.