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

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

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

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

Gets a parameter processor enabler query.

Returnosid.configuration.rules.ParameterProcessorEnablerQuerythe parameter processor enabler query
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorEnablerSearchOrder
Description

Gets a parameter processor enabler search order.

Returnosid.configuration.rules.ParameterProcessorEnablerSearchOrderthe parameter processor enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyParameterProcessorEnablerQuery
Description

Applies a parameter processor enabler query to this configuration.

Parametersosid.configuration.rules.ParameterProcessorEnablerQueryparameterProcessorEnablerQuerythe parameter processor enabler query
ErrorsNULL_ARGUMENT parameterProcessorEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED parameterProcessorEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectParameterProcessorEnablerQuery
Description

Gets a parameter processor enabler query inspector for this configuration.

Returnosid.configuration.rules.ParameterProcessorEnablerQueryInspectorthe parameter processor enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyParameterProcessorEnablerSequencing
Description

Applies a parameter processor enabler search order to this configuration.

Parametersosid.configuration.rules.ParameterProcessorEnablerSearchOrderparameterProcessorEnablerSearchOrderthe parameter processor enabler search order
ErrorsNULL_ARGUMENT parameterProcessorEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED parameterProcessorEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorEnablerQueryFromInspector
Description

Gets a parameter processor enabler query from an inspector.

Parametersosid.configuration.rules.ParameterProcessorEnablerQueryInspectorparameterProcessorEnablerQueryInspectora parameter processor enabler query inspector
Returnosid.configuration.rules.ParameterProcessorEnablerQuerythe parameter processor enabler query
ErrorsNULL_ARGUMENT parameterProcessorEnablerQueryInspector is null
UNSUPPORTED parameterProcessorEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.