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

This session manages queries and sequencing to create "smart" dynamic configurations. A ValueEnablerQuery can be retrieved from this session and mapped to this Configuration to create a virtual collection of value enablers. The value enablers may be sequenced using the ValueEnablerSearchOrder from this session.

This Configuration has a default query that matches any value enabler and a default search order that specifies no sequencing. The queries may be examined using a ValueEnablerQueryInspector. The query may be modified by converting the inspector back to a ValueEnablerQuery.

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.
MethodcanManageSmartConfigurations
Description

Tests if this user can manage smart configurations. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart configuration management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetValueEnablerQuery
Description

Gets a value enabler query.

Returnosid.configuration.rules.ValueEnablerQuerythe value enabler query
CompliancemandatoryThis method must be implemented.
MethodgetValueEnablerSearchOrder
Description

Gets a value enabler search order.

Returnosid.configuration.rules.ValueEnablerSearchOrderthe value enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyValueEnablerQuery
Description

Applies a value enabler query to this configuration.

Parametersosid.configuration.rules.ValueEnablerQueryvalueEnablerQuerythe value enabler query
ErrorsNULL_ARGUMENT valueEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED valueEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectValueEnablerQuery
Description

Gets a value enabler query inspector for this configuration.

Returnosid.configuration.rules.ValueEnablerQueryInspectorthe value enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyValueEnablerSequencing
Description

Applies a value enabler search order to this configuration.

Parametersosid.configuration.rules.ValueEnablerSearchOrdervalueEnablerSearchOrderthe value enabler search order
ErrorsNULL_ARGUMENT valueEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED valueEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetValueEnablerQueryFromInspector
Description

Gets a value enabler query from an inspector.

Parametersosid.configuration.rules.ValueEnablerQueryInspectorvalueEnablerQueryInspectora value enabler query inspector
Returnosid.configuration.rules.ValueEnablerQuerythe value enabler query
ErrorsNULL_ARGUMENT valueEnablerQueryInspector is null
UNSUPPORTED valueEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.