public interface PoolConstrainerRuleApplicationSession extends OsidSession
This session provides methods to apply PoolConstrainers
to Pools.
A Pool
with multiple
PoolConstrainers
means any positive rule evaluation across the
constrainers result in an accessible Pool.
Modifier and Type | Method and Description |
---|---|
void |
assignPoolConstrainerToPool(Id poolConstrainerId,
Id poolId)
Adds an existing
PoolConstrainer to a Pool. |
boolean |
canAssignPoolConstrainers()
Tests if this user can alter pool constrainer/pool mappings.
|
boolean |
canSequencePoolConstrainers()
Tests if this user can order
PoolConstrainers. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
movePoolConstrainerAhead(Id poolConstrainerId,
Id poolId,
Id referenceId)
Reorders pool constrainers for a pool by moving the specified pool
constrainer in front of a reference pool constrainer.
|
void |
movePoolConstrainerBehind(Id poolConstrainerId,
Id poolId,
Id referenceId)
Reorders pool constrainers for a pool by moving the specified pool
constrainer behind a reference pool constrainer.
|
void |
orderPoolConstrainers(Id[] poolConstrainerIds,
Id poolId)
Reorders a set of pool constrainers for a pool.
|
void |
unassignPoolConstrainerFromPool(Id poolConstrainerId,
Id poolId)
Removes a
PoolConstrainer from a Pool. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignPoolConstrainers()
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. void assignPoolConstrainerToPool(Id poolConstrainerId, Id poolId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainer
to a Pool.
poolConstrainerId
- the Id
of the
PoolConstrainer
poolId
- the Id
of the Pool
AlreadyExistsException
- poolConstrainerId
is already applied to poolId
NotFoundException
- poolConstrainerId
or
poolId
not foundNullArgumentException
- poolConstrainerId
or poolId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignPoolConstrainerFromPool(Id poolConstrainerId, Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainer
from a Pool.
poolConstrainerId
- the Id
of the
PoolConstrainer
poolId
- the Id
of the Pool
NotFoundException
- poolConstrainerId
or
poolId
not found or poolConstrainerId
not applied to poolId
NullArgumentException
- poolConstrainerId
or poolId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequencePoolConstrainers()
PoolConstrainers.
A return
of true does not guarantee successful authorization. A return of false
indicates that it is known sequencing operations will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer sequencing operations to an
unauthorized user. false
if PoolConstrainer
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void movePoolConstrainerAhead(Id poolConstrainerId, Id poolId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolConstrainerId
- the Id
of a
PoolConstrainer
poolId
- the Id
of a Pool
referenceId
- the reference pool constrainer Id
NotFoundException
- poolConstrainerId, poolId,
or referenceId
not found or,
poolConstrainerId
or referenceId
not
related to poolId
NullArgumentException
- poolConstrainerId,
poolId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void movePoolConstrainerBehind(Id poolConstrainerId, Id poolId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolConstrainerId
- the Id
of a
PoolConstrainer
poolId
- the Id
of a Pool
referenceId
- the reference pool constrainer Id
NotFoundException
- poolConstrainerId, poolId,
or referenceId
not found or,
poolConstrainerId
or referenceId
not
related to poolId
NullArgumentException
- poolConstrainerId,
poolId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderPoolConstrainers(Id[] poolConstrainerIds, Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolConstrainerIds
- the Ids
for a set of
PoolConstrainers
poolId
- the Id
of a Pool
NotFoundException
- poolId
not found or,
a poolConstrainerId
not related to
poolId
NullArgumentException
- poolConstrainerIds
or poolId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.