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