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

This session provides methods to retrieve ValueEnabler to Configuration mappings. A ValueEnabler 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:

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

Tests if this user can perform lookups of value enabler/configuration mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeValueEnablerConfigurationView
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.
MethodusePlenaryValueEnablerConfigurationView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetValueEnablerIdsByConfiguration
Description

Gets the list of ValueEnablerIds associated with an Configuration.

Parametersosid.id.IdconfigurationId Id of the Configuration
Returnosid.id.IdListlist of related value enabler 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.
MethodgetValueEnablersByConfiguration
Description

Gets the list of value enablers associated with an Configuration.

Parametersosid.id.IdconfigurationId Id of the Configuration
Returnosid.configuration.rules.ValueEnablerListlist of related value enablers
ErrorsNOT_FOUND configurationId is not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetValueEnablerIdsByConfigurations
Description

Gets the list of ValueEnabler Ids corresponding to a list of Configurations.

Parametersosid.id.IdListconfigurationIdslist of configuration Ids
Returnosid.id.IdListlist of value enabler Ids
ErrorsNULL_ARGUMENT configurationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetValueEnablersByConfigurations
Description

Gets the list of value enablers corresponding to a list of Configurations.

Parametersosid.id.IdListconfigurationIdslist of configuration Ids
Returnosid.configuration.rules.ValueEnablerListlist of value enablers
ErrorsNULL_ARGUMENT configurationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationIdsByValueEnabler
Description

Gets the Configuration Ids mapped to a ValueEnabler.

Parametersosid.id.IdvalueEnablerId Id of a ValueEnabler
Returnosid.id.IdListlist of configurations
ErrorsNOT_FOUND valueEnablerId is not found
NULL_ARGUMENT valueEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationsByValueEnabler
Description

Gets the Configurations mapped to a ValueEnabler.

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