public interface PoolProcessorDistributorSession extends OsidSession
This session provides methods to retrieve PoolProcessor
to Distributor
mappings. A PoolProcessor
may
appear in multiple Distributor
objects. Each distributor
may have its own authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPoolProcessorDistributorMappings()
Tests if this user can perform lookups of pool processor/distributor
mappings.
|
IdList |
getDistributorIdsByPoolProcessor(Id poolProcessorId)
Gets the
Distributor Ids mapped to a
PoolProcessor. |
DistributorList |
getDistributorsByPoolProcessor(Id poolProcessorId)
Gets the
Distributors mapped to a PoolProcessor. |
IdList |
getPoolProcessorIdsByDistributor(Id distributorId)
Gets the list of
PoolProcessorIds associated with a
Distributor. |
IdList |
getPoolProcessorIdsByDistributors(IdList distributorIds)
Gets the list of
PoolProcessor Ids corresponding to a
list of Distributors. |
PoolProcessorList |
getPoolProcessorsByDistributor(Id distributorId)
Gets the list of pool processors associated with a
Distributor. |
PoolProcessorList |
getPoolProcessorsByDistributors(IdList distributorIds)
Gets the list of pool processor corresponding to a list of
Distributors. |
void |
useComparativePoolProcessorDistributorView()
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 |
usePlenaryPoolProcessorDistributorView()
A complete view of the
PoolProcessor and
Distributor returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupPoolProcessorDistributorMappings()
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 useComparativePoolProcessorDistributorView()
mandatory
- This method is must be implemented. void usePlenaryPoolProcessorDistributorView()
PoolProcessor
and
Distributor
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. IdList getPoolProcessorIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessorIds
associated with a
Distributor.
distributorId
- Id
of the Distributor
Ids
NotFoundException
- distributorId
is not
foundNullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolProcessorList getPoolProcessorsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor.
distributorId
- Id
of the Distributor
NotFoundException
- distributorId
is not
foundNullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPoolProcessorIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
PoolProcessor Ids
corresponding to a
list of Distributors.
distributorIds
- list of distributor Ids
Ids
NullArgumentException
- distributorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolProcessorList getPoolProcessorsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Distributors.
distributorIds
- list of distributor Ids
NullArgumentException
- distributorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getDistributorIdsByPoolProcessor(Id poolProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
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. DistributorList getDistributorsByPoolProcessor(Id poolProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
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.