public interface AuctionConstrainerRuleApplicationSession extends OsidSession
This session provides methods to apply AuctionConstrainers
to Auctions.
An Auction
with
multiple AuctionConstrainers
means any positive rule
evaluation across the result in an effective Auction.
Modifier and Type | Method and Description |
---|---|
void |
assignAuctionConstrainerToAuction(Id auctionConstrainerId,
Id auctionId)
Adds an existing
AuctionConstrainer to an
Auction. |
boolean |
canAssignAuctionConstrainers()
Tests if this user can alter auction constrainer/auction mappings.
|
boolean |
canSequenceAuctionConstrainers()
Tests if this user can order
AuctionConstrainers. |
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
void |
moveAuctionConstrainerAhead(Id auctionConstrainerId,
Id auctionId,
Id referenceId)
Reorders auction constrainers for an auction by moving the specified
auction constrainer in front of a reference auction constrainer.
|
void |
moveAuctionConstrainerBehind(Id auctionConstrainerId,
Id auctionId,
Id referenceId)
Reorders auction constrainers for an auction by moving the specified
auction constrainer behind a reference auction constrainer.
|
void |
orderAuctionConstrainers(Id[] auctionConstrainerIds,
Id auctionId)
Reorders a set of auction constrainers for an auction.
|
void |
unassignAuctionConstrainerFromAuction(Id auctionConstrainerId,
Id auctionId)
Removes an
AuctionConstrainer from an Auction. |
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 canAssignAuctionConstrainers()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. void assignAuctionConstrainerToAuction(Id auctionConstrainerId, Id auctionId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainer
to an
Auction.
auctionConstrainerId
- the Id
of the
AuctionConstrainer
auctionId
- the Id
of the Auction
AlreadyExistsException
- auctionConstrainerId
already applied to auctionId
NotFoundException
- auctionConstrainerId
or auctionId
not foundNullArgumentException
- auctionConstrainerId
or auctionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAuctionConstrainerFromAuction(Id auctionConstrainerId, Id auctionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainer
from an Auction.
auctionConstrainerId
- the Id
of the
AuctionConstrainer
auctionId
- the Id
of the Auction
NotFoundException
- auctionConstrainerId
or auctionId
not found or
auctionConstrainerId
already applied to
auctionId
NullArgumentException
- auctionConstrainerId
or auctionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceAuctionConstrainers()
AuctionConstrainers.
A
return of true does not guarantee successful authorization. A return
of false indicates that it is known sequencing operations will result
in a PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer sequencing operations to an
unauthorized user. false
if AuctionConstrainer
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveAuctionConstrainerAhead(Id auctionConstrainerId, Id auctionId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionConstrainerId
- the Id
of an
AuctionConstrainer
auctionId
- the Id
of an Auction
referenceId
- the reference auction constrainer Id
NotFoundException
- auctionConstrainerId,
auctionId,
or referenceId
not found or,
auctionConstrainerId
or referenceId
not related to auctionId
NullArgumentException
- auctionConstrainerId,
auctionId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveAuctionConstrainerBehind(Id auctionConstrainerId, Id auctionId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionConstrainerId
- the Id
of an
AuctionConstrainer
auctionId
- the Id
of an Auction
referenceId
- the reference auction constrainer Id
NotFoundException
- auctionConstrainerId,
auctionId,
or referenceId
not found or,
auctionConstrainerId
or referenceId
not related to auctionId
NullArgumentException
- auctionConstrainerId,
auctionId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderAuctionConstrainers(Id[] auctionConstrainerIds, Id auctionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionConstrainerIds
- the Ids
for a set of
AuctionConstrainers
auctionId
- the Id
of an Auction
NotFoundException
- auctionId
not found
or, an auctionConstrainerId
not related to
auctionId
NullArgumentException
- auctionConstrainerIds
or auctionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.