public interface PoolProcessorRuleApplicationSession extends OsidSession
This session provides methods to apply PoolProcessors
to
Pools.
Modifier and Type | Method and Description |
---|---|
void |
assignPoolProcessorToPool(Id poolProcessorId,
Id poolId)
Adds a existing
PoolProcessor to a Pool. |
boolean |
canAssignPoolProcessors()
Tests if this user can alter pool processor/pool mappings.
|
boolean |
canSequencePoolProcessors()
Tests if this user can order
PoolProcessors. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
movePoolProcessorAhead(Id poolProcessorId,
Id poolId,
Id referenceId)
Reorders pool processors for a pool by moving the specified pool
processor in front of a reference pool processor.
|
void |
movePoolProcessorBehind(Id poolProcessorId,
Id poolId,
Id referenceId)
Reorders pool processors for a pool by moving the specified pool
processor behind a reference pool processor.
|
void |
orderPoolProcessors(Id[] poolProcessorIds,
Id poolId)
Reorders a set of pool processors for a pool.
|
void |
unassignPoolProcessorFromPool(Id poolProcessorId,
Id poolId)
Removes a
PoolProcessor 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 canAssignPoolProcessors()
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 assignPoolProcessorToPool(Id poolProcessorId, Id poolId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessor
to a Pool.
poolProcessorId
- the Id
of the
PoolProcessor
poolId
- the Id
of the Pool
AlreadyExistsException
- poolProcessorId
is already applied to poolId
NotFoundException
- poolProcessorId
or
poolId
not foundNullArgumentException
- poolProcessorId
or poolId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignPoolProcessorFromPool(Id poolProcessorId, Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessor
from a Pool.
poolProcessorId
- the Id
of the
PoolProcessor
poolId
- the Id
of the Pool
NotFoundException
- poolProcessorId
or
poolId
not found or poolProcessorId
not applied to poolId
NullArgumentException
- poolProcessorId
or poolId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequencePoolProcessors()
PoolProcessors.
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 PoolProcessor
ordering
is not authorized, true
otherwisemandatory
- This method must be implemented. void movePoolProcessorAhead(Id poolProcessorId, Id poolId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolProcessorId
- the Id
of a
PoolProcessor
poolId
- the Id
of a Pool
referenceId
- the reference pool processor Id
NotFoundException
- poolProcessorId, poolId,
or referenceId
not found or,
poolProcessorId
or referenceId
not
related to poolId
NullArgumentException
- poolProcessorId, poolId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void movePoolProcessorBehind(Id poolProcessorId, Id poolId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolProcessorId
- the Id
of a
PoolProcessor
poolId
- the Id
of a Pool
referenceId
- the reference pool processor Id
NotFoundException
- poolProcessorId, poolId,
or referenceId
not found or,
poolProcessorId
or referenceId
not
related to poolId
NullArgumentException
- poolProcessorId, poolId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderPoolProcessors(Id[] poolProcessorIds, Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolProcessorIds
- the Ids
for a set of
PoolProcessors
poolId
- the Id
of a Pool
NotFoundException
- poolId
not found or,
a poolProcessorId
not related to poolId
NullArgumentException
- poolProcessorIds
or poolId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.