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