OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.ControlProfile
Implementsosid.OsidProfile
Description

The control profile describes the interoperability among control services.

MethodsupportsVisibleFederation
Description

Tests if any trigger federation is exposed. Federation is exposed when a specific trigger may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of triggers appears as a single trigger.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceLookup
Description

Tests if looking up devices is supported.

Returnboolean true if device lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceQuery
Description

Tests if querying devices is supported.

Returnboolean true if device query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceSearch
Description

Tests if searching devices is supported.

Returnboolean true if device search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceAdmin
Description

Tests if a device administrative service is supported.

Returnboolean true if device administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceNotification
Description

Tests if a device notification service is supported.

Returnboolean true if device notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceSystem
Description

Tests if a device system lookup service is supported.

Returnboolean true if a device system lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceSystemAssignment
Description

Tests if a device system assignment service is supported.

Returnboolean true if a device to system assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceSmartSystem
Description

Tests if a device smart system service is supported.

Returnboolean true if an v smart system service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceReturn
Description

Tests if returning devices is supported.

Returnboolean true if returning devices is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsControllerLookup
Description

Tests if looking up controllers is supported.

Returnboolean true if controller lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsControllerQuery
Description

Tests if querying controllers is supported.

Returnboolean true if controller query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsControllerSearch
Description

Tests if searching controllers is supported.

Returnboolean true if controller search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsControllerAdmin
Description

Tests if controller administrative service is supported.

Returnboolean true if controller administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsControllerNotification
Description

Tests if a controller notification service is supported.

Returnboolean true if controller notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsControllerTrigger
Description

Tests if a controller trigger lookup service is supported.

Returnboolean true if a controller trigger lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsControllerTriggerAssignment
Description

Tests if a controller trigger service is supported.

Returnboolean true if controller to trigger assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsControllerSmartTrigger
Description

Tests if a controller smart trigger lookup service is supported.

Returnboolean true if a controller smart trigger service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInputLookup
Description

Tests if looking up inputs is supported.

Returnboolean true if input lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInputQuery
Description

Tests if querying inputs is supported.

Returnboolean true if input query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInputSearch
Description

Tests if searching inputs is supported.

Returnboolean true if input search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInputAdmin
Description

Tests if an input administrative service is supported.

Returnboolean true if input administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInputNotification
Description

Tests if an input notification service is supported.

Returnboolean true if input notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInputSystem
Description

Tests if an input system lookup service is supported.

Returnboolean true if an input system lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInputSystemAssignment
Description

Tests if an input system assignment service is supported.

Returnboolean true if an input to system assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInputSmartSystem
Description

Tests if an input smart system service is supported.

Returnboolean true if a smart system service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSettingLookup
Description

Tests if looking up settings is supported.

Returnboolean true if setting lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSettingQuery
Description

Tests if querying settings is supported.

Returnboolean true if setting query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSettingSearch
Description

Tests if searching settings is supported.

Returnboolean true if setting search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSettingAdmin
Description

Tests if setting administrative service is supported.

Returnboolean true if setting administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSettingNotification
Description

Tests if a setting notification service is supported.

Returnboolean true if setting notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSettingSystem
Description

Tests if a setting system lookup service is supported.

Returnboolean true if a setting system lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSettingSystemAssignment
Description

Tests if a setting system assignment service is supported.

Returnboolean true if a setting to system assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSettingSmartSystem
Description

Tests if a setting smart system service is supported.

Returnboolean true if a setting smart system service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSceneLookup
Description

Tests if looking up scenes is supported.

Returnboolean true if scene lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSceneQuery
Description

Tests if querying scenes is supported.

Returnboolean true if scene query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSceneSearch
Description

Tests if searching scenes is supported.

Returnboolean true if scene search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSceneAdmin
Description

Tests if scene administrative service is supported.

Returnboolean true if scene administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSceneNotification
Description

Tests if a scene notification service is supported.

Returnboolean true if scene notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSceneSystem
Description

Tests if a scene system lookup service is supported.

Returnboolean true if a scene system lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSceneSystemAssignment
Description

Tests if a scene system assignment service is supported.

Returnboolean true if a scene to system assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSceneSmartSystem
Description

Tests if a scene smart system service is supported.

Returnboolean true if a scene smart system service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTriggerLookup
Description

Tests if looking up triggers is supported.

Returnboolean true if trigger lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTriggerQuery
Description

Tests if querying triggers is supported.

Returnboolean true if a trigger query service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTriggerSearch
Description

Tests if searching triggers is supported.

Returnboolean true if trigger search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTriggerAdmin
Description

Tests if trigger administrative service is supported.

Returnboolean true if trigger administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTriggerNotification
Description

Tests if a trigger notification service is supported.

Returnboolean true if trigger notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTriggerSystem
Description

Tests if a trigger system lookup service is supported.

Returnboolean true if a trigger system lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTriggerSystemAssignment
Description

Tests if a trigger system service is supported.

Returnboolean true if trigger to system assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTriggerSmartSystem
Description

Tests if a trigger smart system lookup service is supported.

Returnboolean true if a trigger smart system service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActionGroupLookup
Description

Tests if looking up action groups is supported.

Returnboolean true if action group lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActionGroupQuery
Description

Tests if querying action groups is supported.

Returnboolean true if an action group query service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActionGroupSearch
Description

Tests if searching action groups is supported.

Returnboolean true if action group search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActionGroupAdmin
Description

Tests if action group administrative service is supported.

Returnboolean true if action group administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActionGroupNotification
Description

Tests if an action group notification service is supported.

Returnboolean true if action group notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActionGroupSystem
Description

Tests if an action group system lookup service is supported.

Returnboolean true if an action group system lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActionGroupSystemAssignment
Description

Tests if an action group system service is supported.

Returnboolean true if action group to system assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActionGroupSmartSystem
Description

Tests if an action group smart system lookup service is supported.

Returnboolean true if an action group smart system service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSystemLookup
Description

Tests if looking up systems is supported.

Returnboolean true if system lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSystemQuery
Description

Tests if querying systems is supported.

Returnboolean true if a system query service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSystemSearch
Description

Tests if searching systems is supported.

Returnboolean true if system search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSystemAdmin
Description

Tests if system administrative service is supported.

Returnboolean true if system administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSystemNotification
Description

Tests if a system notification service is supported.

Returnboolean true if system notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSystemHierarchy
Description

Tests for the availability of a system hierarchy traversal service.

Returnboolean true if system hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsSystemHierarchyDesign
Description

Tests for the availability of a system hierarchy design service.

Returnboolean true if system hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsControlBatch
Description

Tests for the availability of a control batch service.

Returnboolean true if control batch service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsControlRules
Description

Tests for the availability of a control rules service.

Returnboolean true if control rules service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDeviceRecordTypes
Description

Gets the supported Device record types.

Returnosid.type.TypeLista list containing the supported Device record types
CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceRecordType
Description

Tests if the given Device record type is supported.

Parametersosid.type.TypedeviceRecordTypea Type indicating a Device record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT deviceRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetDeviceSearchRecordTypes
Description

Gets the supported Device search types.

Returnosid.type.TypeLista list containing the supported Device search types
CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceSearchRecordType
Description

Tests if the given Device search type is supported.

Parametersosid.type.TypedeviceSearchRecordTypea Type indicating a Device search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT effiortSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetDeviceReturnRecordTypes
Description

Gets the supported DeviceReturn record types.

Returnosid.type.TypeLista list containing the supported DeviceReturn record types
CompliancemandatoryThis method must be implemented.
MethodsupportsDeviceReturnRecordType
Description

Tests if the given DeviceReturn record type is supported.

Parametersosid.type.TypedeviceReturnRecordTypea Type indicating a DeviceReturn record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT deviceReturnRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetControllerRecordTypes
Description

Gets the supported Controller record types.

Returnosid.type.TypeLista list containing the supported Controller record types
CompliancemandatoryThis method must be implemented.
MethodsupportsControllerRecordType
Description

Tests if the given Controller record type is supported.

Parametersosid.type.TypecontrollerRecordTypea Type indicating a Controller record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT controllerRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetControllerSearchRecordTypes
Description

Gets the supported Controller search record types.

Returnosid.type.TypeLista list containing the supported Controller search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsControllerSearchRecordType
Description

Tests if the given Controller search record type is supported.

Parametersosid.type.TypecontrollerSearchRecordTypea Type indicating a Controller search record type
Returnboolean true if the given search record type is supported, false otherwise
ErrorsNULL_ARGUMENT controllerSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetInputRecordTypes
Description

Gets the supported Input record types.

Returnosid.type.TypeLista list containing the supported Input record types
CompliancemandatoryThis method must be implemented.
MethodsupportsInputRecordType
Description

Tests if the given Input record type is supported.

Parametersosid.type.TypeinputRecordTypea Type indicating an Input record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT inputRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetInputSearchRecordTypes
Description

Gets the supported Input search types.

Returnosid.type.TypeLista list containing the supported Input search types
CompliancemandatoryThis method must be implemented.
MethodsupportsInputSearchRecordType
Description

Tests if the given Input search type is supported.

Parametersosid.type.TypeinputSearchRecordTypea Type indicating an Input search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT inputSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetSettingRecordTypes
Description

Gets the supported Setting record types.

Returnosid.type.TypeLista list containing the supported Setting record types
CompliancemandatoryThis method must be implemented.
MethodsupportsSettingRecordType
Description

Tests if the given Setting record type is supported.

Parametersosid.type.TypesettingRecordTypea Type indicating a Setting record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT settingRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetSettingSearchRecordTypes
Description

Gets the supported Setting search types.

Returnosid.type.TypeLista list containing the supported Setting search types
CompliancemandatoryThis method must be implemented.
MethodsupportsSettingSearchRecordType
Description

Tests if the given Setting search type is supported.

Parametersosid.type.TypesettingSearchRecordTypea Type indicating a Setting search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT settingSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetSceneRecordTypes
Description

Gets the supported Scene record types.

Returnosid.type.TypeLista list containing the supported Scene record types
CompliancemandatoryThis method must be implemented.
MethodsupportsSceneRecordType
Description

Tests if the given Scene record type is supported.

Parametersosid.type.TypesceneRecordTypea Type indicating a Scene record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT sceneRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetSceneSearchRecordTypes
Description

Gets the supported Scene search types.

Returnosid.type.TypeLista list containing the supported Scene search types
CompliancemandatoryThis method must be implemented.
MethodsupportsSceneSearchRecordType
Description

Tests if the given Scene search type is supported.

Parametersosid.type.TypesceneSearchRecordTypea Type indicating a Scene search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT sceneSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetTriggerRecordTypes
Description

Gets the supported Trigger record types.

Returnosid.type.TypeLista list containing the supported Trigger types
CompliancemandatoryThis method must be implemented.
MethodsupportsTriggerRecordType
Description

Tests if the given Trigger record type is supported.

Parametersosid.type.TypetriggerRecordTypea Type indicating a Trigger record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT triggerRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetTriggerSearchRecordTypes
Description

Gets the supported Trigger search record types.

Returnosid.type.TypeLista list containing the supported Trigger search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsTriggerSearchRecordType
Description

Tests if the given Trigger search record type is supported.

Parametersosid.type.TypetriggerSearchRecordTypea Type indicating a Trigger search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT triggerSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupRecordTypes
Description

Gets the supported ActionGroup record types.

Returnosid.type.TypeLista list containing the supported ActionGroup types
CompliancemandatoryThis method must be implemented.
MethodsupportsActionGroupRecordType
Description

Tests if the given ActionGroup record type is supported.

Parametersosid.type.TypeactionGroupRecordTypea Type indicating an ActionGroup record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT actionGroupRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupSearchRecordTypes
Description

Gets the supported ActionGroup search record types.

Returnosid.type.TypeLista list containing the supported ActionGroup search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsActionGroupSearchRecordType
Description

Tests if the given ActionGroup search record type is supported.

Parametersosid.type.TypeactionGroupSearchRecordTypea Type indicating an ActionGroup search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT actionGroupSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetActionRecordTypes
Description

Gets the supported Action record types.

Returnosid.type.TypeLista list containing the supported Action types
CompliancemandatoryThis method must be implemented.
MethodsupportsActionRecordType
Description

Tests if the given Action record type is supported.

Parametersosid.type.TypeactionRecordTypea Type indicating an Action record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT actionRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetSystemRecordTypes
Description

Gets the supported System record types.

Returnosid.type.TypeLista list containing the supported System types
CompliancemandatoryThis method must be implemented.
MethodsupportsSystemRecordType
Description

Tests if the given System record type is supported.

Parametersosid.type.TypesystemRecordTypea Type indicating a System record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT systemRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetSystemSearchRecordTypes
Description

Gets the supported System search record types.

Returnosid.type.TypeLista list containing the supported System search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsSystemSearchRecordType
Description

Tests if the given System search record type is supported.

Parametersosid.type.TypesystemSearchRecordTypea Type indicating a System search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT systemSearchRecordType is null
CompliancemandatoryThis method must be implemented.