OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ParameterConfigurationSession
Implementsosid.OsidSession
Description

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:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupParameterConfigurations
Description

Tests if this user can perform lookups on configurations of parameters. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations.

Returnboolean false if lookups are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeParameterView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryParameterView
Description

A complete view of the 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.

CompliancemandatoryThis method is must be implemented.
MethodgetParameterIdsByConfiguration
Description

Gets the list of Parameter Ids associated with a Configuration.

Parametersosid.id.IdconfigurationId Id of the Configuration
Returnosid.id.IdListlist of matching parameter Ids
ErrorsNOT_FOUND configurationId is not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParametersByConfiguration
Description

Gets the list of Parameters associated with a Configuration.

Parametersosid.id.IdconfigurationId Id of the Configuration
Returnosid.configuration.ParameterListlist of matching parameters
ErrorsNOT_FOUND configurationId is not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParameterIdsByConfigurations
Description

Gets the list of Parameter Ids associated with a list of Configurations.

Parametersosid.id.IdListconfigurationIdslist of configurations
Returnosid.id.IdListlist of parameter Ids
ErrorsNULL_ARGUMENT configurationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParametersByConfigurations
Description

Gets the list of Parameters associated with a list of Configurations.

Parametersosid.id.IdListconfigurationIdslist of configurations
Returnosid.configuration.ParameterListlist of parameters
ErrorsNULL_ARGUMENT configurationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationIdsByParameter
Description

Gets the Configuration Ids mapped to a Parameter.

Parametersosid.id.IdparameterId Id of a Parameter
Returnosid.id.IdListlist of configuration Ids
ErrorsNOT_FOUND parameterId is not found
NULL_ARGUMENT parameterId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationsByParameter
Description

Gets the Configurations mapped to a Parameter.

Parametersosid.id.IdparameterId Id of a Parameter
Returnosid.configuration.ConfigurationListlist of configurations
ErrorsNOT_FOUND parameterId is not found
NULL_ARGUMENT parameterId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.