public interface ParameterProcessorEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve
ParameterProcessorEnabler
to ParameterProcessor
mappings. A ParameterProcessor
with multiple
ParameterProcessorEnablers
means any positive rule evaluation
across the enablers result in an effective ParameterProcessor.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupParameterProcessorEnablerRules()
Tests if this user can perform lookups of parameter processor
enabler/parameter processor mappings.
|
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
IdList |
getParameterProcessorEnablerIdsForParameterProcessor(Id parameterProcessorId)
Gets the
ParameterProcessorEnabler Id associated with a
ParameterProcessor. |
ParameterProcessorEnablerList |
getParameterProcessorEnablersForParameterProcessor(Id parameterProcessorId)
Gets the
ParameterProcessorEnabler associated with a
ParameterProcessor. |
IdList |
getParameterProcessorIdsForParameterProcessorEnabler(Id parameterProcessorEnablerId)
Gets the
ParameterProcessor Ids mapped
to a ParameterProcessorEnabler. |
ParameterProcessorList |
getParameterProcessorsForParameterProcessorEnabler(Id parameterProcessorEnablerId)
Gets the
ParameterProcessors mapped to a
ParameterProcessorEnabler. |
void |
useComparativeParameterProcessorEnablerRuleView()
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 |
useFederatedConfigurationView()
Federates the view for methods in this session.
|
void |
useIsolatedConfigurationView()
Isolates the view for methods in this session.
|
void |
usePlenaryParameterProcessorEnablerRuleView()
A complete view of the
ParameterProcessorEnabler and
ParameterProcessor returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getConfigurationId()
Configuration
Id
associated
with this session. Configuration Id
associated with this
sessionmandatory
- This method must be implemented. Configuration getConfiguration() throws OperationFailedException, PermissionDeniedException
Configuration
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupParameterProcessorEnablerRules()
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 useComparativeParameterProcessorEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryParameterProcessorEnablerRuleView()
ParameterProcessorEnabler
and
ParameterProcessor
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 useFederatedConfigurationView()
mandatory
- This method is must be implemented. void useIsolatedConfigurationView()
mandatory
- This method is must be implemented. IdList getParameterProcessorEnablerIdsForParameterProcessor(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessorEnabler Id
associated with a
ParameterProcessor.
parameterProcessorId
- Id
of the
ParameterProcessor
Ids
NotFoundException
- parameterProcessorId
is not foundNullArgumentException
- parameterProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorEnablerList getParameterProcessorEnablersForParameterProcessor(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessorEnabler
associated with a
ParameterProcessor.
parameterProcessorId
- Id
of the
ParameterProcessor
NotFoundException
- parameterProcessorId
is not foundNullArgumentException
- parameterProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getParameterProcessorIdsForParameterProcessorEnabler(Id parameterProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessor
Ids
mapped
to a ParameterProcessorEnabler.
parameterProcessorEnablerId
- Id
of a
ParameterProcessorEnabler
Ids
NotFoundException
- parameterProcessorEnablerId
is not foundNullArgumentException
-
parameterProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorList getParameterProcessorsForParameterProcessorEnabler(Id parameterProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessors
mapped to a
ParameterProcessorEnabler.
parameterProcessorEnablerId
- Id
of a
ParameterProcessorEnabler
NotFoundException
- parameterProcessorEnablerId
is not foundNullArgumentException
-
parameterProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.