public interface PoolConstrainerEnablerDistributorSession extends OsidSession
This session provides methods to retrieve PoolConstrainerEnabler
to Distributor
mappings. A
PoolConstrainerEnabler
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 |
canLookupPoolConstrainerEnablerDistributorMappings()
Tests if this user can perform lookups of pool constrainer
enabler/distributor mappings.
|
IdList |
getDistributorIdsByPoolConstrainerEnabler(Id poolConstrainerEnablerId)
Gets the
Distributor Ids mapped to a
PoolConstrainerEnabler. |
DistributorList |
getDistributorsByPoolConstrainerEnabler(Id poolConstrainerEnablerId)
Gets the
Distributors mapped to a
PoolConstrainerEnabler. |
IdList |
getPoolConstrainerEnablerIdsByDistributor(Id distributorId)
Gets the list of
PoolConstrainerEnablerIds associated
with a Distributor. |
IdList |
getPoolConstrainerEnablerIdsByDistributors(IdList distributorIds)
Gets the list of
PoolConstrainerEnabler Ids
corresponding to a list of Distributors. |
PoolConstrainerEnablerList |
getPoolConstrainerEnablersByDistributor(Id distributorId)
Gets the list of pool constrainer enablers associated with a
Distributor. |
PoolConstrainerEnablerList |
getPoolConstrainerEnablersByDistributors(IdList distributorIds)
Gets the list of pool constrainer enablers corresponding to a list of
Distributors. |
void |
useComparativePoolConstrainerEnablerDistributorView()
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 |
usePlenaryPoolConstrainerEnablerDistributorView()
A complete view of the
PoolConstrainerEnabler and
Distributor returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupPoolConstrainerEnablerDistributorMappings()
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 useComparativePoolConstrainerEnablerDistributorView()
mandatory
- This method is must be implemented. void usePlenaryPoolConstrainerEnablerDistributorView()
PoolConstrainerEnabler
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 getPoolConstrainerEnablerIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainerEnablerIds
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. PoolConstrainerEnablerList getPoolConstrainerEnablersByDistributor(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 getPoolConstrainerEnablerIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
PoolConstrainerEnabler 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. PoolConstrainerEnablerList getPoolConstrainerEnablersByDistributors(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 getDistributorIdsByPoolConstrainerEnabler(Id poolConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributor
Ids
mapped to a
PoolConstrainerEnabler.
poolConstrainerEnablerId
- Id
of a
PoolConstrainerEnabler
NotFoundException
- poolConstrainerEnablerId
is not foundNullArgumentException
- poolConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DistributorList getDistributorsByPoolConstrainerEnabler(Id poolConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Distributors
mapped to a
PoolConstrainerEnabler.
poolConstrainerEnablerId
- Id
of a
PoolConstrainerEnabler
NotFoundException
- poolConstrainerEnablerId
is not foundNullArgumentException
- poolConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.