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