public interface PoolConstrainerEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve PoolConstrainerEnabler
to PoolConstrainer
mappings. A
PoolConstrainer
with multiple PoolConstrainerEnablers
means any positive rule evaluation across the enablers result in
an effective PoolConstrainer.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPoolConstrainerEnablerRules()
Tests if this user can perform lookups of pool constrainer
enabler/pool constrainer mappings.
|
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
IdList |
getPoolConstrainerEnablerIdsForPoolConstrainer(Id poolConstrainerId)
Gets the
PoolConstrainerEnabler Id associated with a
PoolConstrainer. |
PoolConstrainerEnablerList |
getPoolConstrainerEnablersForPoolConstrainer(Id poolConstrainerId)
Gets the
PoolConstrainerEnablers associated with a
PoolConstrainer. |
IdList |
getPoolConstrainerIdsForPoolConstrainerEnabler(Id poolConstrainerEnablerId)
Gets the
PoolConstrainer Ids mapped to a
PoolConstrainerEnabler. |
PoolConstrainerList |
getPoolConstrainersForPoolConstrainerEnabler(Id poolConstrainerEnablerId)
Gets the
PoolConstrainers mapped to a
PoolConstrainerEnabler. |
void |
useComparativePoolConstrainerEnablerRuleView()
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 |
usePlenaryPoolConstrainerEnablerRuleView()
A complete view of the
PoolConstrainerEnabler and
PoolConstrainer 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 canLookupPoolConstrainerEnablerRules()
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 useComparativePoolConstrainerEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryPoolConstrainerEnablerRuleView()
PoolConstrainerEnabler
and
PoolConstrainer
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 getPoolConstrainerEnablerIdsForPoolConstrainer(Id poolConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainerEnabler Id
associated with a
PoolConstrainer.
poolConstrainerId
- Id
of the
PoolConstrainer
Ids
NotFoundException
- poolConstrainerId
is
not foundNullArgumentException
- poolConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolConstrainerEnablerList getPoolConstrainerEnablersForPoolConstrainer(Id poolConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainerEnablers
associated with a
PoolConstrainer.
poolConstrainerId
- Id
of the
PoolConstrainer
NotFoundException
- poolConstrainerId
is
not foundNullArgumentException
- poolConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPoolConstrainerIdsForPoolConstrainerEnabler(Id poolConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainer
Ids
mapped to a
PoolConstrainerEnabler.
poolConstrainerEnablerId
- Id
of a
PoolConstrainerEnabler
Ids
NotFoundException
- poolConstrainerEnablerId
is not foundNullArgumentException
- poolConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolConstrainerList getPoolConstrainersForPoolConstrainerEnabler(Id poolConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainers
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.