public interface PoolDistributorSession extends OsidSession
This session provides methods to retrieve Pool
to
Distributor
mappings. A Pool
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 |
canLookupPoolDistributorMappings()
Tests if this user can perform lookups of pool/distributor mappings.
|
IdList |
getDistributorIdsByPool(Id poolId)
Gets the
Distributor Ids mapped to a
Pool. |
DistributorList |
getDistributorsByPool(Id poolId)
Gets the
Distributors mapped to a Pool. |
IdList |
getPoolIdsByDistributor(Id distributorId)
Gets the list of
Pool Ids associated with a
Distributor. |
IdList |
getPoolIdsByDistributors(IdList distributorIds)
Gets the list of
Pool Ids corresponding to a list of
Distributors. |
PoolList |
getPoolsByDistributor(Id distributorId)
Gets the list of
Pools associated with a
Distributor. |
PoolList |
getPoolsByDistributors(IdList distributorIds)
Gets the list of
Pool corresponding to a list of
Distributors. |
void |
useComparativePoolDistributorView()
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 |
usePlenaryPoolDistributorView()
A complete view of the
Pool and Distributor
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupPoolDistributorMappings()
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 useComparativePoolDistributorView()
mandatory
- This method is must be implemented. void usePlenaryPoolDistributorView()
Pool
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 getPoolIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Pool Ids
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. PoolList getPoolsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Pools
associated with a
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 getPoolIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Pool 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. PoolList getPoolsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
Pool
corresponding to a list of
Distributors.
distributorIds
- list of distributor Ids
NullArgumentException
- distributorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getDistributorIdsByPool(Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
mapped to a
Pool.
poolId
- Id
of a Pool
NotFoundException
- poolId
is not foundNullArgumentException
- poolId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DistributorList getDistributorsByPool(Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
mapped to a Pool.
poolId
- Id
of a Pool
NotFoundException
- poolId
is not foundNullArgumentException
- poolId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.