public interface AuctionConstrainerEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply
AuctionConstrainerEnablers
to AuctionConstrainers.
An AuctionConstrainer
with multiple
AuctionConstrainerEnablers
means any positive rule evaluation
across the enablers result in an effective AuctionConstrainer.
Modifier and Type | Method and Description |
---|---|
void |
assignAuctionConstrainerEnablerToAuctionConstrainer(Id auctionConstrainerEnablerId,
Id auctionConstrainerId)
Adds an existing
AuctionConstrainerEnabler to an
AuctionConstrainer. |
boolean |
canAssignAuctionConstrainerEnablers()
Tests if this user can alter auction constrainer enabler/auction
constrainer mappings.
|
boolean |
canSequenceAuctionConstrainerEnablers()
Tests if this user can order
AuctionConstrainerEnablers. |
AuctionHouse |
getAuctionHouse()
Gets the
AuctionHouse associated with this session. |
Id |
getAuctionHouseId()
Gets the
AuctionHouse Id associated with
this session. |
void |
moveAuctionConstrainerEnablerAhead(Id auctionConstrainerEnablerId,
Id auctionConstrainerId,
Id referenceId)
Reorders auction constrainer enablers for an auction constrainer by
moving the specified auction constrainer enabler in front of a
reference auction constrainer enabler.
|
void |
moveAuctionConstrainerEnablerBehind(Id auctionConstrainerEnablerId,
Id auctionConstrainerId,
Id referenceId)
Reorders auction constrainer enablers for an auction by moving the
specified auction constrainer enabler behind a reference auction
constrainer enabler.
|
void |
orderAuctionConstrainerEnablers(Id[] auctionConstrainerEnablerIds,
Id auctionConstrainerId)
Reorders a set of auction constrainer enablers for an auction
constrainer.
|
void |
unassignAuctionConstrainerEnablerFromAuctionConstrainer(Id auctionConstrainerEnablerId,
Id auctionConstrainerId)
Removes an
AuctionConstrainerEnabler from an
AuctionConstrainer. |
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 canAssignAuctionConstrainerEnablers()
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 assignAuctionConstrainerEnablerToAuctionConstrainer(Id auctionConstrainerEnablerId, Id auctionConstrainerId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainerEnabler
to an
AuctionConstrainer.
auctionConstrainerEnablerId
- the Id
of the
AuctionConstrainerEnabler
auctionConstrainerId
- the Id
of the
AuctionConstrainer
AlreadyExistsException
-
auctionConstrainerEnablerId
already applied to
auctionConstrainerId
NotFoundException
- auctionConstrainerEnablerId
or auctionConstrainerId
not foundNullArgumentException
-
auctionConstrainerEnablerId
or
auctionConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAuctionConstrainerEnablerFromAuctionConstrainer(Id auctionConstrainerEnablerId, Id auctionConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuctionConstrainerEnabler
from an
AuctionConstrainer.
auctionConstrainerEnablerId
- the Id
of the
AuctionConstrainerEnabler
auctionConstrainerId
- the Id
of the
AuctionConstrainer
NotFoundException
- auctionConstrainerEnablerId
or auctionConstrainerId
not found or
auctionConstrainerEnablerId
not applied to
auctionConstrainerId
NullArgumentException
-
auctionConstrainerEnablerId
or
auctionConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceAuctionConstrainerEnablers()
AuctionConstrainerEnablers.
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 AuctionConstrainerEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveAuctionConstrainerEnablerAhead(Id auctionConstrainerEnablerId, Id auctionConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionConstrainerEnablerId
- the Id
of an
AuctionConstrainerEnabler
auctionConstrainerId
- the Id
of an
AuctionConstrainer
referenceId
- the reference auction constrainer enabler
Id
NotFoundException
- auctionConstrainerEnablerId,
auctionConstrainerId,
or referenceId
not found or, auctionConstrainerEnablerId
or
referenceId
not related to
auctionConstrainerId
NullArgumentException
-
auctionConstrainerEnablerId, auctionConstrainerId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveAuctionConstrainerEnablerBehind(Id auctionConstrainerEnablerId, Id auctionConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionConstrainerEnablerId
- the Id
of an
AuctionConstrainerEnabler
auctionConstrainerId
- the Id
of an
AuctionConstrainer
referenceId
- the reference auction constrainer enabler
Id
NotFoundException
- auctionConstrainerEnablerId,
auctionConstrainerId,
or referenceId
not found or, auctionConstrainerEnablerId
or
referenceId
not related to
auctionConstrainerId
NullArgumentException
-
auctionConstrainerEnablerId, auctionConstrainerId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderAuctionConstrainerEnablers(Id[] auctionConstrainerEnablerIds, Id auctionConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auctionConstrainerEnablerIds
- the Ids
for a set
of AuctionConstrainerEnablers
auctionConstrainerId
- the Id
of an
AuctionConstrainer
NotFoundException
- auctionConstraienrId
not found or, an auctionConstrainerEnablerId
not related to auctionConstrainerId
NullArgumentException
-
auctionConstrainerEnablerIds
or
auctionConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.