public interface ParameterProcessorRuleLookupSession extends OsidSession
This session provides methods to retrieve ParameterProcessor
to Parameter
mappings.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupParameterProcessorRules()
Tests if this user can perform lookups of parameter
processor/parameter mappings.
|
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
IdList |
getParameterIdsForParameterProcessor(Id parameterProcessorId)
Gets the
Parameter Ids mapped to an
ParameterProcessor. |
IdList |
getParameterProcessorIdsForParameter(Id parameterId)
Gets the
ParameterProcessor Id associated with a
Parameter. |
ParameterProcessorList |
getParameterProcessorsForParameter(Id parameterId)
Gets the
ParameterProcessor associated with a
Parameter. |
ParameterList |
getParametersForParameterProcessor(Id parameterProcessorId)
Gets the
Parameters mapped to an
ParameterProcessor. |
void |
useComparativeParameterProcessorRuleView()
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 |
usePlenaryParameterProcessorRuleView()
A complete view of the
ParameterProcessor and
Parameter 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 canLookupParameterProcessorRules()
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 useComparativeParameterProcessorRuleView()
mandatory
- This method is must be implemented. void usePlenaryParameterProcessorRuleView()
ParameterProcessor
and
Parameter
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 getParameterProcessorIdsForParameter(Id parameterId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessor Id
associated with a
Parameter.
parameterId
- Id
of the Parameter
Ids
NotFoundException
- parameterId
is not
foundNullArgumentException
- parameterId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorList getParameterProcessorsForParameter(Id parameterId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessor
associated with a
Parameter.
parameterId
- Id
of the Parameter
NotFoundException
- parameterId
is not
foundNullArgumentException
- parameterId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getParameterIdsForParameterProcessor(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Parameter
Ids
mapped to an
ParameterProcessor.
parameterProcessorId
- Id
of an
ParameterProcessor
Ids
NotFoundException
- parameterProcessorId
is not foundNullArgumentException
- parameterProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterList getParametersForParameterProcessor(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Parameters
mapped to an
ParameterProcessor.
parameterProcessorId
- Id
of an
ParameterProcessor
NotFoundException
- parameterProcessorId
is not foundNullArgumentException
- parameterProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.