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