OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SettingSmartSystemSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A SettingQuery can be retrieved from this session and systemped to this System to create a virtual collection of Settings. The settings may be sequenced using the SettingSearchOrder from this session.

This System has a default query that matches any setting and a default search order that specifies no sequencing. The queries may be examined using a SettingQueryInspector. The query may be modified by converting the inspector back to a SettingQuery.

MethodgetSystemId
Description

Gets the System Id associated with this session.

Returnosid.id.Idthe System Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSystem
Description

Gets the System associated with this session.

Returnosid.control.Systemthe system
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartSystems
Description

Tests if this user can manage smart systems. 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 system management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSettingQuery
Description

Gets a setting query.

Returnosid.control.SettingQuerythe setting query
CompliancemandatoryThis method must be implemented.
MethodgetSettingSearchOrder
Description

Gets a setting search order.

Returnosid.control.SettingSearchOrderthe setting search order
CompliancemandatoryThis method must be implemented.
MethodapplySettingQuery
Description

Applies a setting query to this system.

Parametersosid.control.SettingQuerysettingQuerythe setting query
ErrorsNULL_ARGUMENT settingQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED settingQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectSettingQuery
Description

Gets a setting query inspector for this system.

Returnosid.control.SettingQueryInspectorthe setting query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplySettingSequencing
Description

Applies a setting search order to this system.

Parametersosid.control.SettingSearchOrdersettingSearchOrderthe setting search order
ErrorsNULL_ARGUMENT settingSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED settingSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSettingQueryFromInspector
Description

Gets a setting query from an inspector.

Parametersosid.control.SettingQueryInspectorsettingQueryInspectora setting query inspector
Returnosid.control.SettingQuerythe setting query
ErrorsNULL_ARGUMENT settingQueryInspector is null
UNSUPPORTED settingQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.