public interface AuctionProcessorEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply AuctionProcessorEnablers
to AuctionProcessors.
An AuctionProcessor
with multiple AuctionProcessorEnablers
means any
positive rule evaluation across the enablers result in an effective
AuctionProcessor.
Modifier and Type | Method and Description |
---|---|
void |
assignAuctionProcessorEnablerToAuctionProcessor(Id auctionProcessorEnablerId,
Id auctionProcessorId)
Adds an existing
AuctionProcessorEnabler to an
AuctionProcessor. |
boolean |
canAssignAuctionProcessorEnablers()
Tests if this user can alter auction processor enabler/auction
processor mappings.
|
boolean |
canSequenceAuctionProcessorEnablers()
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 |
moveAuctionProcessorEnablerAhead(Id auctionProcessorEnablerId,
Id auctionProcessorId,
Id referenceId)
Reorders auction processor enablers for an auction processor by moving
the specified auction processor enabler in front of a reference
auction processor enabler.
|
void |
moveAuctionProcessorEnablerBehind(Id auctionProcessorEnablerId,
Id auctionProcessorId,
Id referenceId)
Reorders auction processor enablers for an auction processor by moving
the specified auction processor enabler behind a reference auction
processor enabler.
|
void |
orderAuctionProcessorEnablers(Id[] auctionProcessorEnablerIds,
Id auctionProcessorId)
Reorders a set of auction processor enablers for an auction processor.
|
void |
unassignAuctionProcessorEnablerFromAuctionProcessor(Id auctionProcessorEnablerId,
Id auctionProcessorId)
Removes an
AuctionProcessorEnabler from an
AuctionProcessor. |
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 canAssignAuctionProcessorEnablers()
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 assignAuctionProcessorEnablerToAuctionProcessor(Id auctionProcessorEnablerId, Id auctionProcessorId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessorEnabler
to an
AuctionProcessor.
auctionProcessorEnablerId
- the Id
of the
AuctionProcessorEnabler
auctionProcessorId
- the Id
of the
AuctionProcessor
AlreadyExistsException
-
auctionProcessorEnablerId
already applied to
auctionProcessorId
NotFoundException
- auctionProcessorEnablerId
or auctionProcessorId
not foundNullArgumentException
-
auctionProcessorEnablerId
or auctionProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAuctionProcessorEnablerFromAuctionProcessor(Id auctionProcessorEnablerId, Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionProcessorEnabler
from an
AuctionProcessor.
auctionProcessorEnablerId
- the Id
of the
AuctionProcessorEnabler
auctionProcessorId
- the Id
of the
AuctionProcessor
NotFoundException
- auctionProcessorEnablerId
or auctionProcessorId
not found or not
mappedNullArgumentException
-
auctionProcessorEnablerId
or auctionProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceAuctionProcessorEnablers()
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 AuctionProcessorEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveAuctionProcessorEnablerAhead(Id auctionProcessorEnablerId, Id auctionProcessorId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionProcessorEnablerId
- the Id
of an
AuctionProcessorEnabler
auctionProcessorId
- the Id
of an
AuctionProcessor
referenceId
- the reference auction processor Id
NotFoundException
- auctionProcessorEnablerId,
auctionProcesorId,
or referenceId
not
found or, auctionProcessorEnablerId
or
referenceId
not related to auctionProcessorId
NullArgumentException
-
auctionProcessorEnablerId, auctionProcessorId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveAuctionProcessorEnablerBehind(Id auctionProcessorEnablerId, Id auctionProcessorId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionProcessorEnablerId
- the Id
of an
AuctionProcessorEnabler
auctionProcessorId
- the Id
of an
AuctionProcessor
referenceId
- the reference auction processor Id
NotFoundException
- auctionProcessorEnablerId,
auctionProcesorId,
or referenceId
not
found or, auctionProcessorEnablerId
or
referenceId
not related to auctionProcessorId
NullArgumentException
-
auctionProcessorEnablerId, auctionProcessorId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderAuctionProcessorEnablers(Id[] auctionProcessorEnablerIds, Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionProcessorEnablerIds
- the Ids
for a set of
AuctionProcessorEnablers
auctionProcessorId
- the Id
of an
AuctionProcessor
NotFoundException
- auctionProcessorId
not found or, an auctionProcessorEnablerId
not
related to auctionProcessorId
NullArgumentException
-
auctionProcessorEnablerIds
or
auctionProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.