public interface AuctionConstrainerEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve
AuctionConstrainerEnabler
to AuctionConstrainer
mappings. An Auction
with multiple
AuctionConstrainerEnablers
means any positive rule evaluation
across the enablers result in an effective Auction.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAuctionConstrainerEnablerRules()
Tests if this user can perform lookups of auction constrainer
enabler/auction constrainer mappings.
|
IdList |
getAuctionConstrainerEnablerIdsForAuctionConstrainer(Id auctionConstrainerId)
Gets the
AuctionConstrainerEnabler Id associated with
an AuctionConstrainer. |
AuctionConstrainerEnablerList |
getAuctionConstrainerEnablersForAuctionConstrainer(Id auctionConstrainerId)
Gets the
AuctionConstrainerEnablers associated with an
AuctionConstrainer. |
IdList |
getAuctionConstrainerIdsForAuctionConstrainerEnabler(Id auctionConstrainerEnablerId)
Gets the
AuctionConstrainer Ids mapped
to an AuctionConstrainerEnabler. |
AuctionConstrainerList |
getAuctionConstrainersForAuctionConstrainerEnabler(Id auctionConstrainerEnablerId)
Gets the
AuctionConstrainers mapped to an
AuctionConstrainerEnabler. |
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
void |
useComparativeAuctionConstrainerEnablerRuleView()
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 |
usePlenaryAuctionConstrainerEnablerRuleView()
A complete view of the
AuctionConstrainerEnabler and
AuctionConstrainer 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 canLookupAuctionConstrainerEnablerRules()
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 useComparativeAuctionConstrainerEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryAuctionConstrainerEnablerRuleView()
AuctionConstrainerEnabler
and
AuctionConstrainer
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 getAuctionConstrainerEnablerIdsForAuctionConstrainer(Id auctionConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainerEnabler Id
associated with
an AuctionConstrainer.
auctionConstrainerId
- Id
of the
AuctionConstrainer
Ids
NotFoundException
- auctionConstrainerId
is not foundNullArgumentException
- auctionConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionConstrainerEnablerList getAuctionConstrainerEnablersForAuctionConstrainer(Id auctionConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainerEnablers
associated with an
AuctionConstrainer.
auctionConstrainerId
- Id
of the
AuctionConstrainer
NotFoundException
- auctionConstrainerId
is not foundNullArgumentException
- auctionConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAuctionConstrainerIdsForAuctionConstrainerEnabler(Id auctionConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainer
Ids
mapped
to an AuctionConstrainerEnabler.
auctionConstrainerEnablerId
- Id
of an
AuctionConstrainerEnabler
Ids
NotFoundException
- auctionConstrainerEnablerId
is not foundNullArgumentException
-
auctionConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuctionConstrainerList getAuctionConstrainersForAuctionConstrainerEnabler(Id auctionConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainers
mapped to an
AuctionConstrainerEnabler.
auctionConstrainerEnablerId
- Id
of an
AuctionConstrainerEnabler
NotFoundException
- auctionConstrainerEnablerId
is not foundNullArgumentException
-
auctionConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.