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