public interface PoolConstrainerRuleLookupSession extends OsidSession
This session provides methods to retrieve PoolConstrainer
to Pool
mappings. A Pool
with
multiple PoolConstrainers
means any positive rule
evaluation across the constrainers result in an accessible Pool.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPoolConstrainerRules()
Tests if this user can perform lookups of pool constrainer/pool
mappings.
|
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
IdList |
getPoolConstrainerIdsForPool(Id poolId)
Gets the
PoolConstrainer Id associated with a
Pool. |
PoolConstrainerList |
getPoolConstrainersForPool(Id poolId)
Gets the
PoolConstrainer associated with a Pool. |
IdList |
getPoolIdsForPoolConstrainer(Id poolConstrainerId)
Gets the
Pool Ids mapped to a
PoolConstrainer. |
PoolList |
getPoolsForPoolConstrainer(Id poolConstrainerId)
Gets the
Pools mapped to a PoolConstrainer. |
void |
useComparativePoolConstrainerRuleView()
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 |
useFederatedDistributorView()
Federates the view for methods in this session.
|
void |
useIsolatedDistributorView()
Isolates the view for methods in this session.
|
void |
usePlenaryPoolConstrainerRuleView()
A complete view of the
PoolConstrainer and Pool
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupPoolConstrainerRules()
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 useComparativePoolConstrainerRuleView()
mandatory
- This method is must be implemented. void usePlenaryPoolConstrainerRuleView()
PoolConstrainer
and Pool
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. void useFederatedDistributorView()
mandatory
- This method is must be implemented. void useIsolatedDistributorView()
mandatory
- This method is must be implemented. IdList getPoolConstrainerIdsForPool(Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainer Id
associated with a
Pool.
poolId
- Id
of the Pool
Ids
NotFoundException
- poolId
is not foundNullArgumentException
- poolId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolConstrainerList getPoolConstrainersForPool(Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainer
associated with a Pool.
poolId
- Id
of the Pool
NotFoundException
- poolId
is not foundNullArgumentException
- poolId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPoolIdsForPoolConstrainer(Id poolConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Pool
Ids
mapped to a
PoolConstrainer.
poolConstrainerId
- Id
of a
PoolConstrainer
Ids
NotFoundException
- poolConstrainerId
is
not foundNullArgumentException
- poolConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolList getPoolsForPoolConstrainer(Id poolConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Pools
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.