public interface PoolProcessorRuleLookupSession extends OsidSession
This session provides methods to retrieve PoolProcessor
to Pool
mappings.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPoolProcessorRules()
Tests if this user can perform lookups of pool processor/pool
mappings.
|
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
IdList |
getPoolIdsForPoolProcessor(Id poolProcessorId)
Gets the
Pool Ids mapped to a
PoolProcessor. |
IdList |
getPoolProcessorIdsForPool(Id poolId)
Gets the
PoolProcessor Id associated with a
Pool. |
PoolProcessorList |
getPoolProcessorsForPool(Id poolId)
Gets the
PoolProcessor associated with a Pool. |
PoolList |
getPoolsForPoolProcessor(Id poolProcessorId)
Gets the
Pools mapped to a PoolProcessor. |
void |
useComparativePoolProcessorRuleView()
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 |
usePlenaryPoolProcessorRuleView()
A complete view of the
PoolProcessor and Pool
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 canLookupPoolProcessorRules()
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 useComparativePoolProcessorRuleView()
mandatory
- This method is must be implemented. void usePlenaryPoolProcessorRuleView()
PoolProcessor
and Pool
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 getPoolProcessorIdsForPool(Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessor Id
associated with a
Pool.
poolId
- Id
of the Pool
Ids
NotFoundException
- poolId
is not foundNullArgumentException
- poolId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolProcessorList getPoolProcessorsForPool(Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessor
associated with a Pool.
poolId
- Id
of the Pool
NotFoundException
- poolId
is not foundNullArgumentException
- poolId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPoolIdsForPoolProcessor(Id poolProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Pool
Ids
mapped to a
PoolProcessor.
poolProcessorId
- Id
of a PoolProcessor
Ids
NotFoundException
- poolProcessorId
is
not foundNullArgumentException
- poolProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolList getPoolsForPoolProcessor(Id poolProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Pools
mapped to a PoolProcessor.
poolProcessorId
- Id
of a PoolProcessor
NotFoundException
- poolProcessorId
is
not foundNullArgumentException
- poolProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.