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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ParameterQuery can be retrieved from this session and mapped to this Configuration to create a virtual collection of Parameters. The parameters may be sequenced using the ParameterSearchOrder from this session.

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

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 associated with this session
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 cobfiguration management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetParameterQuery
Description

Gets a parameter query.

Returnosid.configuration.ParameterQuerythe parameter query
CompliancemandatoryThis method must be implemented.
MethodgetParameterSearchOrder
Description

Gets a parameter search order.

Returnosid.configuration.ParameterSearchOrderthe parameter search order
CompliancemandatoryThis method must be implemented.
MethodapplyParameterQuery
Description

Applies a parameter query to this configuration.

Parametersosid.configuration.ParameterQueryparameterQuerythe parameter query
ErrorsNULL_ARGUMENT parameterQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED parameterQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspecParameterQuery
Description

Gets a parameter query inspector for this configuration.

Returnosid.configuration.ParameterQueryInspectorthe parameter query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyParameterSequencing
Description

Applies a parameter search order to this configuration.

Parametersosid.configuration.ParameterSearchOrderparameterSearchOrderthe parameter search order
ErrorsNULL_ARGUMENT parameterSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED parameterSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetParameterQueryFromInspector
Description

Gets a parameter query from an inspector.

Parametersosid.configuration.ParameterQueryInspectorparameterQueryInspectora parameter query inspector
Returnosid.configuration.ParameterQuerythe parameter query
ErrorsNULL_ARGUMENT parameterQueryInspector is null
UNSUPPORTED parameterQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.