public interface ParameterProcessorConfigurationSession extends OsidSession
This session provides methods to retrieve ParameterProcessor
to Configuration
mappings. A
ParameterProcessor
may appear in multiple Configuration
objects. Each configuration 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 |
canLookupParameterProcessorConfigurationMappings()
Tests if this user can perform lookups of parameter
processor/configuration mappings.
|
IdList |
getConfigurationIdsByParameterProcessor(Id parameterProcessorId)
Gets the
Configuration Ids mapped to a
ParameterProcessor. |
ConfigurationList |
getConfigurationsByParameterProcessor(Id parameterProcessorId)
Gets the
Configurations mapped to a
ParameterProcessor. |
IdList |
getParameterProcessorIdsByConfiguration(Id configurationId)
Gets the list of
ParameterProcessorIds associated with
an Configuration. |
IdList |
getParameterProcessorIdsByConfigurations(IdList configurationIds)
Gets the list of
ParameterProcessor Ids corresponding
to a list of Configurations. |
ParameterProcessorList |
getParameterProcessorsByConfiguration(Id configurationId)
Gets the list of parameter processors associated with an
Configuration. |
ParameterProcessorList |
getParameterProcessorsByConfigurations(IdList configurationIds)
Gets the list of parameter processor corresponding to a list of
Configurations. |
void |
useComparativeParameterProcessorConfigurationView()
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 |
usePlenaryParameterProcessorConfigurationView()
A complete view of the
ParameterProcessor and
Configuration returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupParameterProcessorConfigurationMappings()
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 useComparativeParameterProcessorConfigurationView()
mandatory
- This method is must be implemented. void usePlenaryParameterProcessorConfigurationView()
ParameterProcessor
and
Configuration
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 getParameterProcessorIdsByConfiguration(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessorIds
associated with
an Configuration.
configurationId
- Id
of the Configuration
Ids
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorList getParameterProcessorsByConfiguration(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Configuration.
configurationId
- Id
of the Configuration
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getParameterProcessorIdsByConfigurations(IdList configurationIds) throws OperationFailedException, PermissionDeniedException
ParameterProcessor Ids
corresponding
to a list of Configurations.
configurationIds
- list of configuration Ids
Ids
NullArgumentException
- configurationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterProcessorList getParameterProcessorsByConfigurations(IdList configurationIds) throws OperationFailedException, PermissionDeniedException
Configurations.
configurationIds
- list of configuration Ids
NullArgumentException
- configurationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getConfigurationIdsByParameterProcessor(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Configuration
Ids
mapped to a
ParameterProcessor.
parameterProcessorId
- Id
of a
ParameterProcessor
NotFoundException
- parameterProcessorId
is not foundNullArgumentException
- parameterProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConfigurationList getConfigurationsByParameterProcessor(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Configurations
mapped to a
ParameterProcessor.
parameterProcessorId
- Id
of a
ParameterProcessor
NotFoundException
- parameterProcessorId
is not foundNullArgumentException
- parameterProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.