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

This session manages queries and sequencing to create "smart" dynamic catalogs. A InputQuery can be retrieved from this session and systemped to this System to create a virtual collection of Inputs. The inputs may be sequenced using the InputSearchOrder from this session.

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

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

Gets an input query.

Returnosid.control.InputQuerythe input query
CompliancemandatoryThis method must be implemented.
MethodgetInputSearchOrder
Description

Gets an input search order.

Returnosid.control.InputSearchOrderthe input search order
CompliancemandatoryThis method must be implemented.
MethodapplyInputQuery
Description

Applies an input query to this system.

Parametersosid.control.InputQueryinputQuerythe input query
ErrorsNULL_ARGUMENT inputQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED inputQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectInputQuery
Description

Gets an input query inspector for this system.

Returnosid.control.InputQueryInspectorthe input query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyInputSequencing
Description

Applies an input search order to this system.

Parametersosid.control.InputSearchOrderinputSearchOrderthe input search order
ErrorsNULL_ARGUMENT inputSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED inputSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInputQueryFromInspector
Description

Gets an input query from an inspector.

Parametersosid.control.InputQueryInspectorinputQueryInspectoran input query inspector
Returnosid.control.InputQuerythe input query
ErrorsNULL_ARGUMENT inputQueryInspector is null
UNSUPPORTED inputQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.