public interface PoolProcessorDistributorAssignmentSession extends OsidSession
This session provides methods to re-assign PoolProcessor
to Distributor
mappings. A PoolProcessor
may
appear in multiple Distributor
objects and removing the
last reference to a PoolProcessor
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 PoolProcessor
to another
Distributor
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignPoolProcessorToDistributor(Id poolProcessorId,
Id distributorId)
Adds an existing
PoolProcessor to a Distributor. |
boolean |
canAssignPoolProcessors()
Tests if this user can alter pool processor/distributor mappings.
|
boolean |
canAssignPoolProcessorsToDistributor(Id distributorId)
Tests if this user can alter pool processor/distributor mappings.
|
IdList |
getAssignableDistributorIds(Id distributorId)
Gets a list of distributors including and under the given distributor
node in which any pool processor can be assigned.
|
IdList |
getAssignableDistributorIdsForPoolProcessor(Id distributorId,
Id poolProcessorId)
Gets a list of distributors including and under the given distributor
node in which a specific pool processor can be assigned.
|
void |
unassignPoolProcessorFromDistributor(Id poolProcessorId,
Id distributorId)
Removes a
PoolProcessor from a Distributor. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignPoolProcessors()
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 canAssignPoolProcessorsToDistributor(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 getAssignableDistributorIdsForPoolProcessor(Id distributorId, Id poolProcessorId) throws OperationFailedException
distributorId
- the Id
of the Distributor
poolProcessorId
- the Id
of the
PoolProcessor
Ids
NullArgumentException
- distributorId
or
poolProcessorId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignPoolProcessorToDistributor(Id poolProcessorId, Id distributorId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessor
to a Distributor.
poolProcessorId
- the Id
of the
PoolProcessor
distributorId
- the Id
of the Distributor
AlreadyExistsException
- poolProcessorId
is already assigned to distributorId
NotFoundException
- poolProcessorId
or
distributorId
not foundNullArgumentException
- poolProcessorId
or distributorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignPoolProcessorFromDistributor(Id poolProcessorId, Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessor
from a Distributor.
poolProcessorId
- the Id
of the
PoolProcessor
distributorId
- the Id
of the Distributor
NotFoundException
- poolProcessorId
or
distributorId
not found or
poolProcessorId
not assigned to distributorId
NullArgumentException
- poolProcessorId
or distributorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.