public interface AuctionProcessorRuleApplicationSession extends OsidSession
This session provides methods to apply AuctionProcessors
to Auctions.
Modifier and Type | Method and Description |
---|---|
void |
assignAuctionProcessorToAuction(Id auctionProcessorId,
Id auctionId)
Adds an existing
AuctionProcessor to an Auction. |
boolean |
canAssignAuctionProcessors()
Tests if this user can alter auction processor/auction mappings.
|
boolean |
canSequenceAuctionProcessors()
Tests if this user can order
AuctionProcessors. |
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
void |
moveAuctionProcessorAhead(Id auctionProcessorId,
Id auctionId,
Id referenceId)
Reorders auction processors for an auction by moving the specified
auction processor in front of a reference auction processor.
|
void |
moveAuctionProcessorBehind(Id auctionProcessorId,
Id auctionId,
Id referenceId)
Reorders auction processors for an auction by moving the specified
auction processor behind a reference auction processor.
|
void |
orderAuctionProcessors(Id[] auctionProcessorIds,
Id auctionId)
Reorders a set of auction processors for an auction.
|
void |
unassignAuctionProcessorFromAuction(Id auctionProcessorId,
Id auctionId)
Removes an
AuctionProcessor 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 canAssignAuctionProcessors()
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 assignAuctionProcessorToAuction(Id auctionProcessorId, Id auctionId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessor
to an Auction.
auctionProcessorId
- the Id
of the
AuctionProcessor
auctionId
- the Id
of the Auction
AlreadyExistsException
- auctionProcessorId
already applied to auctionId
NotFoundException
- auctionProcessorId
or auctionId
not foundNullArgumentException
- auctionProcessorId
or auctionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAuctionProcessorFromAuction(Id auctionProcessorId, Id auctionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessor
from an Auction.
auctionProcessorId
- the Id
of the
AuctionProcessor
auctionId
- the Id
of the Auction
NotFoundException
- auctionProcessorId
or auctionId
not found or
auctionProcessorId
not applied to auctionId
NullArgumentException
- auctionProcessorId
or auctionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceAuctionProcessors()
AuctionProcessors.
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 AuctionProcessor
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveAuctionProcessorAhead(Id auctionProcessorId, Id auctionId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionProcessorId
- the Id
of an
AuctionProcessor
auctionId
- the Id
of an Auction
referenceId
- the reference auction processor Id
NotFoundException
- auctionProcessorId,
auctionId,
or referenceId
not found or,
auctionProcessorId
or referenceId
not related to auctionId
NullArgumentException
- auctionProcessorId,
auctionId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveAuctionProcessorBehind(Id auctionProcessorId, Id auctionId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionProcessorId
- the Id
of an
AuctionProcessor
auctionId
- the Id
of an Auction
referenceId
- the reference auction processor Id
NotFoundException
- auctionProcessorId,
auctionId,
or referenceId
not found or,
auctionProcessorId
or referenceId
not related to auctionId
NullArgumentException
- auctionProcessorId,
auctionId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderAuctionProcessors(Id[] auctionProcessorIds, Id auctionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionProcessorIds
- the Ids
for a set of
AuctionProcessors
auctionId
- the Id
of an Auction
NotFoundException
- auctionId
not found
or, an auctionProcessorId
not related to
auctionId
NullArgumentException
- auctionProcessorIds
or auctionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.