public interface CommissionEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply CommissionEnablers
to Commissions.
A Commission
with
multiple CommissionEnablers
means any positive rule
evaluation across the enablers result in an accessible Commission.
Modifier and Type | Method and Description |
---|---|
void |
assignCommissionEnablerToCommission(Id commissionEnablerId,
Id commissionId)
Adds an existing
CommissionEnabler to a
Commission. |
boolean |
canAssignCommissionEnablers()
Tests if this user can alter commission enabler/commission mappings.
|
boolean |
canSequenceCommissionEnablers()
Tests if this user can order
CommissionEnablers. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
moveCommissionEnablerAhead(Id commissionEnablerId,
Id commissionId,
Id referenceId)
Reorders commission enablers for a commission by moving the specified
commission enabler in front of a reference commission enabler.
|
void |
moveCommissionEnablerBehind(Id commissionEnablerId,
Id commissionId,
Id referenceId)
Reorders commission enablers for a commission by moving the specified
commission enabler behind a reference commission enabler.
|
void |
orderCommissionEnablers(Id[] commissionEnablerIds,
Id commissionId)
Reorders a set of commission enablers for a commission.
|
void |
unassignCommissionEnablerFromCommission(Id commissionEnablerId,
Id commissionId)
Removes a
CommissionEnabler from a Commission. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignCommissionEnablers()
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 assignCommissionEnablerToCommission(Id commissionEnablerId, Id commissionId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
CommissionEnabler
to a
Commission.
commissionEnablerId
- the Id
of the
CommissionEnabler
commissionId
- the Id
of the Commission
AlreadyExistsException
- commissionEnablerId
is already applied to commissionId
NotFoundException
- commissionEnablerId
or commissionId
not foundNullArgumentException
- commissionEnablerId
or commissionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignCommissionEnablerFromCommission(Id commissionEnablerId, Id commissionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CommissionEnabler
from a Commission.
commissionEnablerId
- the Id
of the
CommissionEnabler
commissionId
- the Id
of the Commission
NotFoundException
- commissionEnablerId
or commissionId
not found or
commissionEnablerId
not applied to commissionId
NullArgumentException
- commissionEnablerId
or commissionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceCommissionEnablers()
CommissionEnablers.
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 CommissionEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveCommissionEnablerAhead(Id commissionEnablerId, Id commissionId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
commissionEnablerId
- the Id
of a
CommissionEnabler
commissionId
- the Id
of a Commission
referenceId
- the reference commission enabler Id
NotFoundException
- commissionEnablerId,
commissionId,
or referenceId
not found
or, commissionEnablerId
or referenceId
not related to commissionId
NullArgumentException
-
commissionEnablerId,commissionId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveCommissionEnablerBehind(Id commissionEnablerId, Id commissionId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
commissionEnablerId
- the Id
of a
CommissionEnabler
commissionId
- the Id
of a Commission
referenceId
- the reference commission enabler Id
NotFoundException
- commissionEnablerId,
commissionId,
or referenceId
not found
or, commissionEnablerId
or referenceId
not related to commissionId
NullArgumentException
-
commissionEnablerId,commissionId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderCommissionEnablers(Id[] commissionEnablerIds, Id commissionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
commissionEnablerIds
- the Ids
for a set of
CommissionnEnablers
commissionId
- the Id
of a Commission
NotFoundException
- commissionId
not
found or, a commissionEnablerId
not related to
commissionId
NullArgumentException
- commissionEnablerIds
or commissionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.