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