public interface QueueDistributorAssignmentSession extends OsidSession
This session provides methods to re-assign Queue
to
Distributor
mappings. A Queue
may appear in
multiple Distributor
objects and removing the last
reference to a Queue
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 Queue
to another
Distributor
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignQueueToDistributor(Id queueId,
Id distributorId)
Adds an existing
Queue to a Distributor. |
boolean |
canAssignQueues()
Tests if this user can alter queue/distributor mappings.
|
boolean |
canAssignQueuesToDistributor(Id distributorId)
Tests if this user can alter queue/distributor mappings.
|
IdList |
getAssignableDistributorIds(Id distributorId)
Gets a list of distributors including and under the given distributor
node in which any queue can be assigned.
|
IdList |
getAssignableDistributorIdsForQueue(Id distributorId,
Id queueId)
Gets a list of distributors including and under the given distributor
node in which a specific queue can be assigned.
|
void |
unassignQueueFromDistributor(Id queueId,
Id distributorId)
Removes a
Queue from a Distributor. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignQueues()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignQueuesToDistributor(Id distributorId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment 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 getAssignableDistributorIdsForQueue(Id distributorId, Id queueId) throws OperationFailedException
distributorId
- the Id
of the Distributor
queueId
- the Id
of the Queue
Ids
NullArgumentException
- distributorId
or
queueId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignQueueToDistributor(Id queueId, Id distributorId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Queue
to a Distributor.
queueId
- the Id
of the Queue
distributorId
- the Id
of the Distributor
AlreadyExistsException
- queueId
is
already assigned to distributorId
NotFoundException
- queueId
or
distributorId
not foundNullArgumentException
- queueId
or
distributorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignQueueFromDistributor(Id queueId, Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Queue
from a Distributor.
queueId
- the Id
of the Queue
distributorId
- the Id
of the Distributor
NotFoundException
- queueId
or
distributorId
not found or queueId
not
assigned to distributorId
NullArgumentException
- queueId
or
distributorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.