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

This session provides methods to retrieve ValueEnabler to Value mappings. A Value with multiple ValueEnablers means any positive rule evaluation across the enablers result in a visible Value.

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
  • isolated configuration view: All methods in this session operate, retrieve and pertain value enablers defined explicitly in the current configuration
  • federated configuration view: All methods in this session operate, retrieve and pertain to all value enablers defined in this configuration and any other value enablers implicitly available in this configuration through configuration inheritence.
MethodgetConfigurationId
Description

Gets the Configuration Id associated with this session.

Returnosid.id.Idthe Configuration Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetConfiguration
Description

Gets the Configuration associated with this session.

Returnosid.configuration.Configurationthe configuration
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupValueEnablerRules
Description

Tests if this user can perform lookups of value enabler/value 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.
MethoduseComparativeValueEnablerRuleView
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.
MethodusePlenaryValueEnablerRuleView
Description

A complete view of the ValueEnabler and Value 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.
MethoduseFederatedConfigurationView
Description

Federates the view for methods in this session. A federated view will include value enablers in configurations which are children of this configuration in the configuration hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedConfigurationView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this configuration only.

CompliancemandatoryThis method is must be implemented.
MethodgetValueEnablerIdsForValue
Description

Gets the ValueEnabler Id associated with a Value.

Parametersosid.id.IdvalueId Id of the Value
Returnosid.id.IdListthe value enabler Ids
ErrorsNOT_FOUND valueId is not found
NULL_ARGUMENT valueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetValueEnablersForValue
Description

Gets the ValueEnablers associated with a Value.

Parametersosid.id.IdvalueId Id of the Value
Returnosid.configuration.rules.ValueEnablerListthe value enablers
ErrorsNOT_FOUND valueId is not found
NULL_ARGUMENT valueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetValueIdsForValueEnabler
Description

Gets the Value Ids mapped to a ValueEnabler.

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

Gets the Values mapped to a ValueEnabler.

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