public interface PoolConstrainerDistributorSession extends OsidSession
This session provides methods to retrieve PoolConstrainer
to Distributor
mappings. A PoolConstrainer
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 |
canLookupPoolConstrainerDistributorMappings()
Tests if this user can perform lookups of pool constrainer/distributor
mappings.
|
IdList |
getDistributorIdsByPoolConstrainer(Id poolConstrainerId)
Gets the
Distributor Ids mapped to a
PoolConstrainer. |
DistributorList |
getDistributorsByPoolConstrainer(Id poolConstrainerId)
Gets the
Distributors mapped to a
PoolConstrainer. |
IdList |
getPoolConstrainerIdsByDistributor(Id distributorId)
Gets the list of
PoolConstrainerIds associated with a
Distributor. |
IdList |
getPoolConstrainerIdsByDistributors(IdList distributorIds)
Gets the list of
PoolConstrainer Ids corresponding to a
list of Distributors. |
PoolConstrainerList |
getPoolConstrainersByDistributor(Id distributorId)
Gets the list of pool constrainer associated with a
Distributor. |
PoolConstrainerList |
getPoolConstrainersByDistributors(IdList distributorIds)
Gets the list of pool constrainer corresponding to a list of
Distributors. |
void |
useComparativePoolConstrainerDistributorView()
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 |
usePlenaryPoolConstrainerDistributorView()
A complete view of the
PoolConstrainer and
Distributor returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupPoolConstrainerDistributorMappings()
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 useComparativePoolConstrainerDistributorView()
mandatory
- This method is must be implemented. void usePlenaryPoolConstrainerDistributorView()
PoolConstrainer
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 getPoolConstrainerIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainerIds
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. PoolConstrainerList getPoolConstrainersByDistributor(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 getPoolConstrainerIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
PoolConstrainer 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. PoolConstrainerList getPoolConstrainersByDistributors(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 getDistributorIdsByPoolConstrainer(Id poolConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
mapped to a
PoolConstrainer.
poolConstrainerId
- Id
of a
PoolConstrainer
NotFoundException
- poolConstrainerId
is
not foundNullArgumentException
- poolConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DistributorList getDistributorsByPoolConstrainer(Id poolConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
mapped to a
PoolConstrainer.
poolConstrainerId
- Id
of a
PoolConstrainer
NotFoundException
- poolConstrainerId
is
not foundNullArgumentException
- poolConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.