public interface ParameterConfigurationSession extends OsidSession
This session defines methods for accessing the configurations of a
parameter. A Parameter
may appear in multiple
Configurations.
Each Configuration
may have its own
authorizations governing who is allowed to look at it.
This lookup session defines two views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupParameterConfigurations()
Tests if this user can perform lookups on configurations of
parameters.
|
IdList |
getConfigurationIdsByParameter(Id parameterId)
Gets the
Configuration Ids mapped to a
Parameter. |
ConfigurationList |
getConfigurationsByParameter(Id parameterId)
Gets the
Configurations mapped to a Parameter. |
IdList |
getParameterIdsByConfiguration(Id configurationId)
Gets the list of
Parameter Ids
associated with a Configuration. |
IdList |
getParameterIdsByConfigurations(IdList configurationIds)
Gets the list of
Parameter Ids associated with a list
of Configurations. |
ParameterList |
getParametersByConfiguration(Id configurationId)
Gets the list of
Parameters associated with a
Configuration. |
ParameterList |
getParametersByConfigurations(IdList configurationIds)
Gets the list of
Parameters associated with a list of
Configurations. |
void |
useComparativeParameterView()
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 |
usePlenaryParameterView()
A complete view of the
Parameter returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupParameterConfigurations()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations. false
if lookups are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeParameterView()
mandatory
- This method is must be implemented. void usePlenaryParameterView()
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. IdList getParameterIdsByConfiguration(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Parameter
Ids
associated with a 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. ParameterList getParametersByConfiguration(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Parameters
associated with a
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 getParameterIdsByConfigurations(IdList configurationIds) throws OperationFailedException, PermissionDeniedException
Parameter Ids
associated with a list
of Configurations.
configurationIds
- list of configurations Ids
NullArgumentException
- configurationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ParameterList getParametersByConfigurations(IdList configurationIds) throws OperationFailedException, PermissionDeniedException
Parameters
associated with a list of
Configurations.
configurationIds
- list of configurationsNullArgumentException
- configurationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getConfigurationIdsByParameter(Id parameterId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Configuration Ids
mapped to a
Parameter.
parameterId
- Id
of a Parameter
Ids
NotFoundException
- parameterId
is not
foundNullArgumentException
- parameterId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConfigurationList getConfigurationsByParameter(Id parameterId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Configurations
mapped to a Parameter.
parameterId
- Id
of a Parameter
NotFoundException
- parameterId
is not
foundNullArgumentException
- parameterId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.