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