Interface | osid.control.ControlProfile | ||
---|---|---|---|
Implements | osid.OsidProfile | ||
Description |
The control profile describes the interoperability among control services. | ||
Method | supportsVisibleFederation | ||
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. | ||
Return | boolean | true if visible federation is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDeviceLookup | ||
Description |
Tests if looking up devices is supported. | ||
Return | boolean | true if device lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDeviceQuery | ||
Description |
Tests if querying devices is supported. | ||
Return | boolean | true if device query is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDeviceSearch | ||
Description |
Tests if searching devices is supported. | ||
Return | boolean | true if device search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDeviceAdmin | ||
Description |
Tests if a device administrative service is supported. | ||
Return | boolean | true if device administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDeviceNotification | ||
Description |
Tests if a device | ||
Return | boolean | true if device notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDeviceSystem | ||
Description |
Tests if a device system lookup service is supported. | ||
Return | boolean | true if a device system lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDeviceSystemAssignment | ||
Description |
Tests if a device system assignment service is supported. | ||
Return | boolean | true if a device to system assignment service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDeviceSmartSystem | ||
Description |
Tests if a device smart system service is supported. | ||
Return | boolean | true if an v smart system service is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDeviceReturn | ||
Description |
Tests if returning devices is supported. | ||
Return | boolean | true if returning devices is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsControllerLookup | ||
Description |
Tests if looking up controllers is supported. | ||
Return | boolean | true if controller lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsControllerQuery | ||
Description |
Tests if querying controllers is supported. | ||
Return | boolean | true if controller query is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsControllerSearch | ||
Description |
Tests if searching controllers is supported. | ||
Return | boolean | true if controller search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsControllerAdmin | ||
Description |
Tests if controller administrative service is supported. | ||
Return | boolean | true if controller administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsControllerNotification | ||
Description |
Tests if a controller notification service is supported. | ||
Return | boolean | true if controller notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsControllerTrigger | ||
Description |
Tests if a controller trigger lookup service is supported. | ||
Return | boolean | true if a controller trigger lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsControllerTriggerAssignment | ||
Description |
Tests if a controller trigger service is supported. | ||
Return | boolean | true if controller to trigger assignment service is
supported, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsControllerSmartTrigger | ||
Description |
Tests if a controller smart trigger lookup service is supported. | ||
Return | boolean | true if a controller smart trigger service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsInputLookup | ||
Description |
Tests if looking up inputs is supported. | ||
Return | boolean | true if input lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsInputQuery | ||
Description |
Tests if querying inputs is supported. | ||
Return | boolean | true if input query is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsInputSearch | ||
Description |
Tests if searching inputs is supported. | ||
Return | boolean | true if input search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsInputAdmin | ||
Description |
Tests if an input administrative service is supported. | ||
Return | boolean | true if input administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsInputNotification | ||
Description |
Tests if an input | ||
Return | boolean | true if input notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsInputSystem | ||
Description |
Tests if an input system lookup service is supported. | ||
Return | boolean | true if an input system lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsInputSystemAssignment | ||
Description |
Tests if an input system assignment service is supported. | ||
Return | boolean | true if an input to system assignment service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsInputSmartSystem | ||
Description |
Tests if an input smart system service is supported. | ||
Return | boolean | true if a smart system service is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSettingLookup | ||
Description |
Tests if looking up settings is supported. | ||
Return | boolean | true if setting lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSettingQuery | ||
Description |
Tests if querying settings is supported. | ||
Return | boolean | true if setting query is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSettingSearch | ||
Description |
Tests if searching settings is supported. | ||
Return | boolean | true if setting search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSettingAdmin | ||
Description |
Tests if setting | ||
Return | boolean | true if setting administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSettingNotification | ||
Description |
Tests if a setting | ||
Return | boolean | true if setting notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSettingSystem | ||
Description |
Tests if a setting system lookup service is supported. | ||
Return | boolean | true if a setting system lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSettingSystemAssignment | ||
Description |
Tests if a setting system assignment service is supported. | ||
Return | boolean | true if a setting to system assignment service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSettingSmartSystem | ||
Description |
Tests if a setting smart system service is supported. | ||
Return | boolean | true if a setting smart system service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSceneLookup | ||
Description |
Tests if looking up scenes is supported. | ||
Return | boolean | true if scene lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSceneQuery | ||
Description |
Tests if querying scenes is supported. | ||
Return | boolean | true if scene query is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSceneSearch | ||
Description |
Tests if searching scenes is supported. | ||
Return | boolean | true if scene search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSceneAdmin | ||
Description |
Tests if scene | ||
Return | boolean | true if scene administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSceneNotification | ||
Description |
Tests if a scene | ||
Return | boolean | true if scene notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSceneSystem | ||
Description |
Tests if a scene system lookup service is supported. | ||
Return | boolean | true if a scene system lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSceneSystemAssignment | ||
Description |
Tests if a scene system assignment service is supported. | ||
Return | boolean | true if a scene to system assignment service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSceneSmartSystem | ||
Description |
Tests if a scene smart system service is supported. | ||
Return | boolean | true if a scene smart system service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTriggerLookup | ||
Description |
Tests if looking up triggers is supported. | ||
Return | boolean | true if trigger lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTriggerQuery | ||
Description |
Tests if querying triggers is supported. | ||
Return | boolean | true if a trigger query service is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTriggerSearch | ||
Description |
Tests if searching triggers is supported. | ||
Return | boolean | true if trigger search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTriggerAdmin | ||
Description |
Tests if trigger administrative service is supported. | ||
Return | boolean | true if trigger administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTriggerNotification | ||
Description |
Tests if a trigger | ||
Return | boolean | true if trigger notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTriggerSystem | ||
Description |
Tests if a trigger system lookup service is supported. | ||
Return | boolean | true if a trigger system lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTriggerSystemAssignment | ||
Description |
Tests if a trigger system service is supported. | ||
Return | boolean | true if trigger to system assignment service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTriggerSmartSystem | ||
Description |
Tests if a trigger smart system lookup service is supported. | ||
Return | boolean | true if a trigger smart system service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActionGroupLookup | ||
Description |
Tests if looking up action groups is supported. | ||
Return | boolean | true if action group lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActionGroupQuery | ||
Description |
Tests if querying action groups is supported. | ||
Return | boolean | true if an action group query service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActionGroupSearch | ||
Description |
Tests if searching action groups is supported. | ||
Return | boolean | true if action group search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActionGroupAdmin | ||
Description |
Tests if action group administrative service is supported. | ||
Return | boolean | true if action group administration is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActionGroupNotification | ||
Description |
Tests if an action group | ||
Return | boolean | true if action group notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActionGroupSystem | ||
Description |
Tests if an action group system lookup service is supported. | ||
Return | boolean | true if an action group system lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActionGroupSystemAssignment | ||
Description |
Tests if an action group system service is supported. | ||
Return | boolean | true if action group to system assignment service is
supported, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActionGroupSmartSystem | ||
Description |
Tests if an action group smart system lookup service is supported. | ||
Return | boolean | true if an action group smart system service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSystemLookup | ||
Description |
Tests if looking up systems is supported. | ||
Return | boolean | true if system lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSystemQuery | ||
Description |
Tests if querying systems is supported. | ||
Return | boolean | true if a system query service is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSystemSearch | ||
Description |
Tests if searching systems is supported. | ||
Return | boolean | true if system search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSystemAdmin | ||
Description |
Tests if system administrative service is supported. | ||
Return | boolean | true if system administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSystemNotification | ||
Description |
Tests if a system | ||
Return | boolean | true if system notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSystemHierarchy | ||
Description |
Tests for the availability of a system hierarchy traversal service. | ||
Return | boolean | true if system hierarchy traversal is available,
false otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | supportsSystemHierarchyDesign | ||
Description |
Tests for the availability of a system hierarchy design service. | ||
Return | boolean | true if system hierarchy design is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsControlBatch | ||
Description |
Tests for the availability of a control batch service. | ||
Return | boolean | true if control batch service is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsControlRules | ||
Description |
Tests for the availability of a control rules service. | ||
Return | boolean | true if control rules service is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDeviceRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Device record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDeviceRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | deviceRecordType | a Type indicating a Device record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | deviceRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDeviceSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Device search types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDeviceSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | deviceSearchRecordType | a Type indicating a Device search type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | effiortSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDeviceReturnRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported DeviceReturn record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDeviceReturnRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | deviceReturnRecordType | a Type indicating a DeviceReturn record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | deviceReturnRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getControllerRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Controller record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsControllerRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | controllerRecordType | a Type indicating a Controller record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | controllerRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getControllerSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Controller search record
types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsControllerSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | controllerSearchRecordType | a Type indicating a Controller search record
type |
Return | boolean | true if the given search record type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | controllerSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getInputRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Input record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsInputRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | inputRecordType | a Type indicating an Input record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | inputRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getInputSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Input search types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsInputSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | inputSearchRecordType | a Type indicating an Input search type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | inputSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getSettingRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Setting record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSettingRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | settingRecordType | a Type indicating a Setting record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | settingRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getSettingSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Setting search types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSettingSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | settingSearchRecordType | a Type indicating a Setting search type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | settingSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getSceneRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Scene record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSceneRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | sceneRecordType | a Type indicating a Scene record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | sceneRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getSceneSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Scene search types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSceneSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | sceneSearchRecordType | a Type indicating a Scene search type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | sceneSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getTriggerRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Trigger types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTriggerRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | triggerRecordType | a Type indicating a Trigger record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | triggerRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getTriggerSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Trigger search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTriggerSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | triggerSearchRecordType | a Type indicating a Trigger search record
type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | triggerSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported ActionGroup types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActionGroupRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | actionGroupRecordType | a Type indicating an ActionGroup record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | actionGroupRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported ActionGroup search record
types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActionGroupSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | actionGroupSearchRecordType | a Type indicating an ActionGroup search
record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | actionGroupSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Action types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsActionRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | actionRecordType | a Type indicating an Action record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | actionRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystemRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported System types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSystemRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | systemRecordType | a Type indicating a System record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | systemRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystemSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported System search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsSystemSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | systemSearchRecordType | a Type indicating a System search record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | systemSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. |