public interface CommissionEnablerFoundryAssignmentSession extends OsidSession
This session provides methods to re-assign CommissionEnabler
to Foundry
mappings. A CommissionEnabler
may appear in multiple Foundry
objects and removing
the last reference to a CommissionEnabler
is the equivalent
of deleting it. Each Foundry
may have its own
authorizations governing who is allowed to operate on it.
Adding a reference of a CommissionEnabler
to another
Foundry
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignCommissionEnablerToFoundry(Id commissionEnablerId,
Id foundryId)
Adds an existing
CommissionEnabler to a Foundry. |
boolean |
canAssignCommissionEnablers()
Tests if this user can alter commission enabler/foundry mappings.
|
boolean |
canAssignCommissionEnablersToFoundry(Id foundryId)
Tests if this user can alter commission enabler/foundry mappings.
|
IdList |
getAssignableFoundryIds(Id foundryId)
Gets a list of foundries including and under the given foundry node in
which any commission enabler can be assigned.
|
IdList |
getAssignableFoundryIdsForCommissionEnabler(Id foundryId,
Id commissionEnablerId)
Gets a list of foundries including and under the given foundry node in
which a specific commission enabler can be assigned.
|
void |
unassignCommissionEnablerFromFoundry(Id commissionEnablerId,
Id foundryId)
Removes a
CommissionEnabler from a Foundry. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
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. boolean canAssignCommissionEnablersToFoundry(Id foundryId)
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users.foundryId
- the Id
of the Foundry
false
if mapping is not authorized, true
otherwiseNullArgumentException
- foundryId
is
null
mandatory
- This method must be implemented. IdList getAssignableFoundryIds(Id foundryId) throws OperationFailedException
foundryId
- the Id
of the Foundry
Ids
NullArgumentException
- foundryId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableFoundryIdsForCommissionEnabler(Id foundryId, Id commissionEnablerId) throws OperationFailedException
foundryId
- the Id
of the Foundry
commissionEnablerId
- the Id
of the
CommissionEnabler
Ids
NullArgumentException
- foundryId
or
commissionEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignCommissionEnablerToFoundry(Id commissionEnablerId, Id foundryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
CommissionEnabler
to a Foundry.
commissionEnablerId
- the Id
of the
CommissionEnabler
foundryId
- the Id
of the Foundry
AlreadyExistsException
- ccommissionEnablerId
is already assigned to foundryId
NotFoundException
- ccommissionEnablerId
or foundryId
not foundNullArgumentException
- commissionEnablerId
or foundryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignCommissionEnablerFromFoundry(Id commissionEnablerId, Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CommissionEnabler
from a Foundry.
commissionEnablerId
- the Id
of the
CommissionEnabler
foundryId
- the Id
of the Foundry
NotFoundException
- commissionEnablerId
or foundryId
not found or
commissionEnablerId
not assigned to foundryId
NullArgumentException
- commissionEnablerId
or foundryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.