public interface PoolProcessorEnablerDistributorSession extends OsidSession
This session provides methods to retrieve PoolProcessorEnabler
to Distributor
mappings. A
PoolProcessorEnabler
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 |
canLookupPoolProcessorEnablerDistributorMappings()
Tests if this user can perform lookups of pool processor
enabler/distributor mappings.
|
IdList |
getDistributorIdsByPoolProcessorEnabler(Id poolProcessorEnablerId)
Gets the
Distributor Ids mapped to a
PoolProcessorEnabler. |
DistributorList |
getDistributorsByPoolProcessorEnabler(Id poolProcessorEnablerId)
Gets the
Distributors mapped to a
PoolProcessorEnabler. |
IdList |
getPoolProcessorEnablerIdsByDistributor(Id distributorId)
Gets the list of
PoolProcessorEnablerIds associated
with a Distributor. |
IdList |
getPoolProcessorEnablerIdsByDistributors(IdList distributorIds)
Gets the list of
PoolProcessorEnabler Ids corresponding
to a list of Distributors. |
PoolProcessorEnablerList |
getPoolProcessorEnablersByDistributor(Id distributorId)
Gets the list of pool processor enablers associated with a
Distributor. |
PoolProcessorEnablerList |
getPoolProcessorEnablersByDistributors(IdList distributorIds)
Gets the list of pool processor enablers corresponding to a list of
Distributors. |
void |
useComparativePoolProcessorEnablerDistributorView()
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 |
usePlenaryPoolProcessorEnablerDistributorView()
A complete view of the
PoolProcessorEnabler and
Distributor returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupPoolProcessorEnablerDistributorMappings()
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 useComparativePoolProcessorEnablerDistributorView()
mandatory
- This method is must be implemented. void usePlenaryPoolProcessorEnablerDistributorView()
PoolProcessorEnabler
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 getPoolProcessorEnablerIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessorEnablerIds
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. PoolProcessorEnablerList getPoolProcessorEnablersByDistributor(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 getPoolProcessorEnablerIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
PoolProcessorEnabler 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. PoolProcessorEnablerList getPoolProcessorEnablersByDistributors(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 getDistributorIdsByPoolProcessorEnabler(Id poolProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
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. DistributorList getDistributorsByPoolProcessorEnabler(Id poolProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
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.