public interface PoolProcessorEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply PoolProcessorEnablers
to PoolProcessors.
A PoolProcessor
with multiple PoolProcessorEnablers
means any positive rule
evaluation across the enablers result in an effective
PoolProcessor.
Modifier and Type | Method and Description |
---|---|
void |
assignPoolProcessorEnablerToPoolProcessor(Id poolProcessorEnablerId,
Id poolProcessorId)
Adds an existing
PoolProcessorEnabler to a
PoolProcessor. |
boolean |
canAssignPoolProcessorEnablers()
Tests if this user can alter pool processor enabler/pool processor
mappings.
|
boolean |
canSequencePoolProcessorEnablers()
Tests if this user can order
PoolProcessorEnablers. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
movePoolProcessorEnablerAhead(Id poolProcessorEnablerId,
Id poolProcessorId,
Id referenceId)
Reorders pool processor enablers for a pool processor by moving the
specified pool processor enabler in front of a reference pool
processor enabler.
|
void |
movePoolProcessorEnablerBehind(Id poolProcessorEnablerId,
Id poolProcessorId,
Id referenceId)
Reorders pool processor enablers for a pool processor by moving the
specified pool processor enabler behind a reference pool processor
enabler.
|
void |
orderPoolProcessorEnablers(Id[] poolProcessorEnablerIds,
Id poolProcessorId)
Reorders a set of pool processor enablers for a pool processor.
|
void |
unassignPoolProcessorEnablerFromPoolProcessor(Id poolProcessorEnablerId,
Id poolProcessorId)
Removes a
PoolProcessorEnabler from a
PoolProcessor. |
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 canAssignPoolProcessorEnablers()
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 assignPoolProcessorEnablerToPoolProcessor(Id poolProcessorEnablerId, Id poolProcessorId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessorEnabler
to a
PoolProcessor.
poolProcessorEnablerId
- the Id
of the
PoolProcessorEnabler
poolProcessorId
- the Id
of the
PoolProcessor
AlreadyExistsException
- poolProcessorEnablerId
is already applied to poolProcessorId
NotFoundException
- poolProcessorEnablerId
or poolProcessorId
not foundNullArgumentException
- poolProcessorEnablerId
or poolProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignPoolProcessorEnablerFromPoolProcessor(Id poolProcessorEnablerId, Id poolProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessorEnabler
from a
PoolProcessor.
poolProcessorEnablerId
- the Id
of the
PoolProcessorEnabler
poolProcessorId
- the Id
of the
PoolProcessor
NotFoundException
- poolProcessorEnablerId
or poolProcessorId
not found or
poolProcessorEnablerId
not applied to
poolProcessorId
NullArgumentException
- poolProcessorEnablerId
or poolProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequencePoolProcessorEnablers()
PoolProcessorEnablers.
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 PoolProcessorEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void movePoolProcessorEnablerAhead(Id poolProcessorEnablerId, Id poolProcessorId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolProcessorEnablerId
- the Id
of a
PoolProcessorEnabler
poolProcessorId
- the Id
of a
PoolProcessor
referenceId
- the reference pool processor enabler Id
NotFoundException
- poolProcessorEnablerId,
poolProcessorId,
or referenceId
not
found or, poolProcessorEnablerId
or
referenceId
not related to poolProcessorId
NullArgumentException
- poolProcessorEnablerId,
poolProcessorId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void movePoolProcessorEnablerBehind(Id poolProcessorEnablerId, Id poolProcessorId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolProcessorEnablerId
- the Id
of a
PoolProcessorEnabler
poolProcessorId
- the Id
of a
PoolProcessor
referenceId
- the reference pool processor enabler Id
NotFoundException
- poolProcessorEnablerId,
poolProcessorId,
or referenceId
not
found or, poolProcessorEnablerId
or
referenceId
not related to poolProcessorId
NullArgumentException
- poolProcessorEnablerId,
poolProcessorId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderPoolProcessorEnablers(Id[] poolProcessorEnablerIds, Id poolProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolProcessorEnablerIds
- the Ids
for a set of
PoolProcessorEnablers
poolProcessorId
- the Id
of a
PoolProcessor
NotFoundException
- poolProcessorId
not
found or, a poolProcessorEnablerId
not related
to poolProcessorId
NullArgumentException
- poolProcessorEnablerIds
or poolProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.