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

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

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

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

Gets a parameter processor query.

Returnosid.configuration.rules.ParameterProcessorQuerythe parameter processor query
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorSearchOrder
Description

Gets a parameter processor search order.

Returnosid.configuration.rules.ParameterProcessorSearchOrderthe parameter processor search order
CompliancemandatoryThis method must be implemented.
MethodapplyParameterProcessorQuery
Description

Applies a parameter processor query to this configuration.

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

Gets a parameter processor query inspector for this configuration.

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

Applies a parameter processor search order to this configuration.

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

Gets a parameter processor query from an inspector.

Parametersosid.configuration.rules.ParameterProcessorQueryInspectorparameterProcessorQueryInspectora parameter processor query inspector
Returnosid.configuration.rules.ParameterProcessorQuerythe parameter processor query
ErrorsNULL_ARGUMENT parameterProcessorQueryInspector is null
UNSUPPORTED parameterProcessorQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.