public interface PoolProcessorEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve PoolProcessorEnabler
to PoolProcessor
mappings. A PoolProcessor
with multiple PoolProcessorEnablers
means any
positive rule evaluation across the enablers result in an effective
PoolProcessor.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPoolProcessorEnablerRules()
Tests if this user can perform lookups of pool processor enabler/pool
processor mappings.
|
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
IdList |
getPoolProcessorEnablerIdsForPoolProcessor(Id poolProcessorId)
Gets the
PoolProcessorEnabler Id associated with a
PoolProcessor. |
PoolProcessorEnablerList |
getPoolProcessorEnablersForPoolProcessor(Id poolProcessorId)
Gets the
PoolProcessorEnabler associated with a
PoolProcessor. |
IdList |
getPoolProcessorIdsForPoolProcessorEnabler(Id poolProcessorEnablerId)
Gets the
PoolProcessor Ids mapped to a
PoolProcessorEnabler. |
PoolProcessorList |
getPoolProcessorsForPoolProcessorEnabler(Id poolProcessorEnablerId)
Gets the
PoolProcessors mapped to a
PoolProcessorEnabler. |
void |
useComparativePoolProcessorEnablerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedDistributorView()
Federates the view for methods in this session.
|
void |
useIsolatedDistributorView()
Isolates the view for methods in this session.
|
void |
usePlenaryPoolProcessorEnablerRuleView()
A complete view of the
PoolProcessorEnabler and
PoolProcessor returns is desired. |
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 canLookupPoolProcessorEnablerRules()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativePoolProcessorEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryPoolProcessorEnablerRuleView()
PoolProcessorEnabler
and
PoolProcessor
returns is desired. Methods will return what is
requested or result in an error. This view is used when greater
precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. void useFederatedDistributorView()
mandatory
- This method is must be implemented. void useIsolatedDistributorView()
mandatory
- This method is must be implemented. IdList getPoolProcessorEnablerIdsForPoolProcessor(Id poolProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessorEnabler Id
associated with a
PoolProcessor.
poolProcessorId
- Id
of the PoolProcessor
Ids
NotFoundException
- poolProcessorId
is
not foundNullArgumentException
- poolProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolProcessorEnablerList getPoolProcessorEnablersForPoolProcessor(Id poolProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessorEnabler
associated with a
PoolProcessor.
poolProcessorId
- Id
of the PoolProcessor
NotFoundException
- poolProcessorId
is
not foundNullArgumentException
- poolProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPoolProcessorIdsForPoolProcessorEnabler(Id poolProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessor
Ids
mapped to a
PoolProcessorEnabler.
poolProcessorEnablerId
- Id
of a
PoolProcessorEnabler
Ids
NotFoundException
- poolProcessorEnablerId
is not foundNullArgumentException
- poolProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolProcessorList getPoolProcessorsForPoolProcessorEnabler(Id poolProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessors
mapped to a
PoolProcessorEnabler.
poolProcessorEnablerId
- Id
of a
PoolProcessorEnabler
NotFoundException
- poolProcessorEnablerId
is not foundNullArgumentException
- poolProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.