OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.ControlManager
Implementsosid.OsidManager
osid.control.ControlProfile
Used Byosid.orchestration.OrchestrationManager
Description

The control manager provides access to control sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • DeviceLookupSession: a session to retrieve devices
  • DeviceQuerySession: a session to query for devicess
  • DeviceSearchSession: a session to search for devices
  • DeviceAdminSession: a session to create and delete devices
  • DeviceNotificationSession: a session to receive notifications pertaining to device changes
  • DeviceSystemSession: a session to look up device system mappings
  • DeviceSystemAssignmentSession: a session to manage device to system mappings
  • DeviceSmartSystemSession: a session to manage dynamic systems of devices
  • ControllerLookupSession: a session to retrieve controllers
  • ControllerQuerySession: a session to query for controllers
  • ControllerSearchSession: a session to search for controllers
  • ControllerAdminSession: a session to create and delete controllers
  • ControllerNotificationSession: a session to receive notifications pertaining to controller changes
  • ControllerSystemSession: a session to look up controller system mappings
  • ControllerSystemAssignmentSession: a session to manage controller to system mappings
  • ControllerSmartSystemSession: a session to manage dynamic systems of controllers
  • InputLookupSession: a session to retrieve inputs
  • InputQuerySession: a session to query for inputs
  • InputSearchSession: a session to search for inputs
  • InputAdminSession: a session to create and delete inputs
  • InputNotificationSession: a session to receive notifications pertaining to input changes
  • InputSystemSession: a session to look up input system mappings
  • InputSystemAssignmentSession: a session to manage inputs to system mappings
  • InputSmartSystemSession: a session to manage dynamic systems of inputs
  • SettingLookupSession: a session to retrieve settings
  • SettingQuerySession: a session to query for settings
  • SettingSearchSession: a session to search for settings
  • SettingAdminSession: a session to create and delete settings
  • SettingNotificationSession: a session to receive notifications pertaining to setting changes
  • SettingSystemsSession: a session to look up setting systems mappings
  • SettingSystemAssignmentSession: a session to manage setting to system mappings
  • SettingSmartSystemSession: a session to manage dynamic systems of settings
  • SceneLookupSession: a session to retrieve scenes
  • SceneQuerySession: a session to query for scenes
  • SceneSearchSession: a session to search for scenes
  • SceneAdminSession: a session to create and delete scenes
  • SceneNotificationSession: a session to receive notifications pertaining to scene changes
  • SceneSystemsSession: a session to look up scene systems mappings
  • SceneSystemAssignmentSession: a session to manage scene to system mappings
  • SceneSmartSystemSession: a session to manage dynamic systems of scenes
  • TriggerLookupSession: a session to retrieve triggers
  • TriggerQuerySession: a session to query for triggers
  • TriggerSearchSession: a session to search for triggers
  • TriggerAdminSession: a session to create and delete triggers
  • TriggerNotificationSession: a session to receive notifications pertaining to trigger changes
  • TriggerSystemSession: a session to look up mappings of triggers to systems
  • TriggerSystemAssignmentSession: a session to manage trigger to system mappings
  • TriggerSmartSystemSession: a session to manage dynamic systems of triggers
  • ActionGroupLookupSession: a session to retrieve action groups
  • ActionGroupQuerySession: a session to query for action groups
  • ActionGroupSearchSession: a session to search for action groups
  • ActionGroupAdminSession: a session to create and delete action groups
  • ActionGroupNotificationSession: a session to receive notifications pertaining to action group changes
  • ActionGroupSystemSession: a session to look up mappings of action groups to systems
  • ActionGroupSystemAssignmentSession: a session to manage action group to system mappings
  • ActionGroupSmartSystemSession: a session to manage dynamic systems of action groups
  • SystemLookupSession: a session to retrieve systems
  • SystemQuerySession: a session to search for systems
  • SystemSearchSession: a session to search for systems
  • SystemAdminSession: a session to create and delete systems
  • SystemNotificationSession: a session to receive notifications pertaining to system changes
  • SystemHierarchySession: a session to traverse a hierarchy of system
  • SystemHierarchyDesignSession: a session to manage a system hierarchy
MethodgetDeviceLookupSession
Description

Gets the OsidSession associated with the device lookup service.

Returnosid.control.DeviceLookupSession a DeviceLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDeviceLookup() is false
Complianceoptional This method must be implemented if supportsDeviceLookup() is true.
MethodgetDeviceLookupSessionForSystem
Description

Gets the OsidSession associated with the device lookup service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.DeviceLookupSession a DeviceLookupSession
ErrorsNOT_FOUND no System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDeviceLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsDeviceLookup() and supportsVisibleFederation() are true
MethodgetDeviceQuerySession
Description

Gets the OsidSession associated with the device query service.

Returnosid.control.DeviceQuerySession a DeviceQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDeviceQuery() is false
Complianceoptional This method must be implemented if supportsDeviceQuery() is true.
MethodgetDeviceQuerySessionForSystem
Description

Gets the OsidSession associated with the device query service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.DeviceQuerySession a DeviceQuerySession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDeviceQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsDeviceQuery() and supportsVisibleFederation() are true
MethodgetDeviceSearchSession
Description

Gets the OsidSession associated with the device search service.

Returnosid.control.DeviceSearchSession a DeviceSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDeviceSearch() is false
Complianceoptional This method must be implemented if supportsDeviceSearch() is true.
MethodgetDeviceSearchSessionForSystem
Description

Gets the OsidSession associated with the device search service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.DeviceSearchSession a DeviceSearchSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDeviceSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsDeviceSearch() and supportsVisibleFederation() are true
MethodgetDeviceAdminSession
Description

Gets the OsidSession associated with the device administration service.

Returnosid.control.DeviceAdminSession a DeviceAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDeviceAdmin() is false
Complianceoptional This method must be implemented if supportsDeviceAdmin() is true.
MethodgetDeviceAdminSessionForSystem
Description

Gets the OsidSession associated with the device administration service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.DeviceAdminSession a DeviceAdminSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDeviceAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsDeviceAdmin() and supportsVisibleFederation() are true
MethodgetDeviceNotificationSession
Description

Gets the OsidSession associated with the device notification service.

Parametersosid.control.DeviceReceiverdeviceReceiver the notification callback
Returnosid.control.DeviceNotificationSession a DeviceNotificationSession
ErrorsNULL_ARGUMENT deviceReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDeviceNotification() is false
Complianceoptional This method must be implemented if supportsDeviceNotification() is true.
MethodgetDeviceNotificationSessionForSystem
Description

Gets the OsidSession associated with the device notification service for the given system.

Parametersosid.control.DeviceReceiverdeviceReceiver the notification callback
osid.id.IdsystemId the Id of the System
Returnosid.control.DeviceNotificationSession a DeviceNotificationSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT deviceReceiver or systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDeviceNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsDeviceNotification() and supportsVisibleFederation() are true
MethodgetDeviceSystemSession
Description

Gets the OsidSession to lookup device/system mappings.

Returnosid.control.DeviceSystemSession a DeviceSystemSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDeviceSystem() is false
Complianceoptional This method must be implemented if supportsDeviceSystem() is true.
MethodgetDeviceSystemAssignmentSession
Description

Gets the OsidSession associated with assigning devices to systems.

Returnosid.control.DeviceSystemAssignmentSession a DeviceSystemAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDeviceSystemAssignment() is false
Complianceoptional This method must be implemented if supportsDeviceSystemAssignment() is true.
MethodgetDeviceSmartSystemSession
Description

Gets the OsidSession to manage device smart systems.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.DeviceSmartSystemSession a DeviceSmartSystemSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDeviceSmartSystem() is false
Complianceoptional This method must be implemented if supportsDeviceSmartSystem() is true.
MethodgetControllerLookupSession
Description

Gets the OsidSession associated with the controller lookup service.

Returnosid.control.ControllerLookupSession a ControllerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControllerLookup() is false
Complianceoptional This method must be implemented if supportsControllerLookup() is true.
MethodgetControllerLookupSessionForSystem
Description

Gets the OsidSession associated with the controller lookup service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.ControllerLookupSession a ControllerLookupSession
ErrorsNOT_FOUND no System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControllerLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsControllerLookup() and supportsVisibleFederation() are true
MethodgetControllerQuerySession
Description

Gets the OsidSession associated with the controller query service.

Returnosid.control.ControllerQuerySession a ControllerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControllerQuery() is false
Complianceoptional This method must be implemented if supportsControllerQuery() is true.
MethodgetControllerQuerySessionForSystem
Description

Gets the OsidSession associated with the controller query service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.ControllerQuerySession a ControllerQuerySession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControllerQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsControllerQuery() and supportsVisibleFederation() are true
MethodgetControllerSearchSession
Description

Gets the OsidSession associated with the controller search service.

Returnosid.control.ControllerSearchSession a ControllerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControllerSearch() is false
Complianceoptional This method must be implemented if supportsControllerSearch() is true.
MethodgetControllerSearchSessionForSystem
Description

Gets the OsidSession associated with the controller search service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.ControllerSearchSession a ControllerSearchSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControllerSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsControllerSearch() and supportsVisibleFederation() are true
MethodgetControllerAdminSession
Description

Gets the OsidSession associated with the controller administration service.

Returnosid.control.ControllerAdminSession a ControllerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControllerAdmin() is false
Complianceoptional This method must be implemented if supportsControllerAdmin() is true.
MethodgetControllerAdminSessionForSystem
Description

Gets the OsidSession associated with the controller administration service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.ControllerAdminSession a ControllerAdminSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControllerAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsControllerAdmin() and supportsVisibleFederation() are true
MethodgetControllerNotificationSession
Description

Gets the OsidSession associated with the controller notification service.

Parametersosid.control.ControllerReceivercontrollerReceiver the notification callback
Returnosid.control.ControllerNotificationSession a ControllerNotificationSession
ErrorsNULL_ARGUMENT controllerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControllerNotification() is false
Complianceoptional This method must be implemented if supportsControllerNotification() is true.
MethodgetControllerNotificationSessionForSystem
Description

Gets the OsidSession associated with the controller notification service for the given system.

Parametersosid.control.ControllerReceivercontrollerReceiver the notification callback
osid.id.IdsystemId the Id of the System
Returnosid.control.ControllerNotificationSession a ControllerNotificationSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT controllerReceiver or systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControllerNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsControllerNotification() and supportsVisibleFederation() are true
MethodgetControllerSystemSession
Description

Gets the OsidSession to lookup controller/system mappings.

Returnosid.control.ControllerSystemSession a ControllerSystemSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControllerSystem() is false
Complianceoptional This method must be implemented if supportsControllerSystem() is true.
MethodgetControllerSystemAssignmentSession
Description

Gets the OsidSession associated with assigning controllers to systems.

Returnosid.control.ControllerSystemAssignmentSession a ControllerSystemAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControllerSystemAssignment() is false
Complianceoptional This method must be implemented if supportsControllerSystemAssignment() is true.
MethodgetControllerSmartSystemSession
Description

Gets the OsidSession to manage controller smart systems.

Parametersosid.id.IdsystemId the Id of the system
Returnosid.control.ControllerSmartSystemSession a ControllerSmartSystemSession
ErrorsNOT_FOUND no System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControllerSmartSystem() is false
Complianceoptional This method must be implemented if supportsControllerSmartSystem() is true.
MethodgetInputLookupSession
Description

Gets the OsidSession associated with the input lookup service.

Returnosid.control.InputLookupSession an InputLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInputLookup() is false
Complianceoptional This method must be implemented if supportsInputLookup() is true.
MethodgetInputLookupSessionForSystem
Description

Gets the OsidSession associated with the input lookup service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.InputLookupSession an InputLookupSession
ErrorsNOT_FOUND no System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInputLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsInputLookup() and supportsVisibleFederation() are true
MethodgetInputQuerySession
Description

Gets the OsidSession associated with the input query service.

Returnosid.control.InputQuerySession an InputQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInputQuery() is false
Complianceoptional This method must be implemented if supportsInputQuery() is true.
MethodgetInputQuerySessionForSystem
Description

Gets the OsidSession associated with the input query service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.InputQuerySession an InputQuerySession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInputQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsInputQuery() and supportsVisibleFederation() are true
MethodgetInputSearchSession
Description

Gets the OsidSession associated with the input search service.

Returnosid.control.InputSearchSession an InputSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInputSearch() is false
Complianceoptional This method must be implemented if supportsInputSearch() is true.
MethodgetInputSearchSessionForSystem
Description

Gets the OsidSession associated with the input search service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.InputSearchSession an InputSearchSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInputSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsInputSearch() and supportsVisibleFederation() are true
MethodgetInputAdminSession
Description

Gets the OsidSession associated with the input administration service.

Returnosid.control.InputAdminSession an InputAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInputAdmin() is false
Complianceoptional This method must be implemented if supportsInputAdmin() is true.
MethodgetInputAdminSessionForSystem
Description

Gets the OsidSession associated with the input administration service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.InputAdminSession an InputAdminSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInputAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsInputAdmin() and supportsVisibleFederation() are true
MethodgetInputNotificationSession
Description

Gets the OsidSession associated with the input notification service.

Parametersosid.control.InputReceiverinputReceiver the notification callback
Returnosid.control.InputNotificationSession an InputNotificationSession
ErrorsNULL_ARGUMENT inputReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInputNotification() is false
Complianceoptional This method must be implemented if supportsInputNotification() is true.
MethodgetInputNotificationSessionForSystem
Description

Gets the OsidSession associated with the input notification service for the given system.

Parametersosid.control.InputReceiverinputReceiver the notification callback
osid.id.IdsystemId the Id of the System
Returnosid.control.InputNotificationSession an InputNotificationSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT inputReceiver or systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInputNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsInputNotification() and supportsVisibleFederation() are true
MethodgetInputSystemSession
Description

Gets the OsidSession to lookup input/system mappings.

Returnosid.control.InputSystemSession an InputSystemSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInputSystem() is false
Complianceoptional This method must be implemented if supportsInputSystem() is true.
MethodgetInputSystemAssignmentSession
Description

Gets the OsidSession associated with assigning inputs to systems.

Returnosid.control.InputSystemAssignmentSession an InputSystemAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInputSystemAssignment() is false
Complianceoptional This method must be implemented if supportsInputSystemAssignment() is true.
MethodgetInputSmartSystemSession
Description

Gets the OsidSession to manage input smart systems.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.InputSmartSystemSession an InputSmartSystemSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsInputSmartSystem() is false
Complianceoptional This method must be implemented if supportsInputSmartSystem() is true.
MethodgetSettingLookupSession
Description

Gets the OsidSession associated with the setting lookup service.

Returnosid.control.SettingLookupSession a SettingLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSettingLookup() is false
Complianceoptional This method must be implemented if supportsSettingLookup() is true.
MethodgetSettingLookupSessionForSystem
Description

Gets the OsidSession associated with the setting lookup service for the given system.

Parametersosid.id.IdsystemId the Id of the system
Returnosid.control.SettingLookupSession a SettingLookupSession
ErrorsNOT_FOUND no System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSettingLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsSettingLookup() and supportsVisibleFederation() are true
MethodgetSettingQuerySession
Description

Gets the OsidSession associated with the setting query service.

Returnosid.control.SettingQuerySession a SettingQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSettingQuery() is false
Complianceoptional This method must be implemented if supportsSettingQuery() is true.
MethodgetSettingQuerySessionForSystem
Description

Gets the OsidSession associated with the setting query service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.SettingQuerySession a SettingQuerySession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSettingQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsSettingQuery() and supportsVisibleFederation() are true
MethodgetSettingSearchSession
Description

Gets the OsidSession associated with the setting search service.

Returnosid.control.SettingSearchSession a SettingSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSettingSearch() is false
Complianceoptional This method must be implemented if supportsSettingSearch() is true.
MethodgetSettingSearchSessionForSystem
Description

Gets the OsidSession associated with the setting search service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.SettingSearchSession a SettingSearchSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSettingSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsSettingSearch() and supportsVisibleFederation() are true
MethodgetSettingAdminSession
Description

Gets the OsidSession associated with the setting administration service.

Returnosid.control.SettingAdminSession a SettingAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSettingAdmin() is false
Complianceoptional This method must be implemented if supportsSettingAdmin() is true.
MethodgetSettingAdminSessionForInput
Description

Gets the OsidSession associated with the setting administration service for the given system.

Parametersosid.id.IdsystemId the Id of the Dostributor
Returnosid.control.SettingAdminSession a SettingAdminSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSettingAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsSettingAdmin() and supportsVisibleFederation() are true
MethodgetSettingNotificationSession
Description

Gets the OsidSession associated with the setting notification service.

Parametersosid.control.SettingReceiversettingReceiver the notification callback
Returnosid.control.SettingNotificationSession a SettingNotificationSession
ErrorsNULL_ARGUMENT settingReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSettingNotification() is false
Complianceoptional This method must be implemented if supportsSettingNotification() is true.
MethodgetSettingNotificationSessionForSystem
Description

Gets the OsidSession associated with the setting notification service for the given system.

Parametersosid.control.SettingReceiversettingReceiver the notification callback
osid.id.IdsystemId the Id of the System
Returnosid.control.SettingNotificationSession a SettingNotificationSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT settingReceiver or systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSettingNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsSettingNotification() and supportsVisibleFederation() are true
MethodgetSettingSystemSession
Description

Gets the OsidSession to lookup setting/system mappings.

Returnosid.control.SettingSystemSession a SettingSystemSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSettingSystem() is false
Complianceoptional This method must be implemented if supportsSettingSystem() is true.
MethodgetSettingSystemAssignmentSession
Description

Gets the OsidSession associated with assigning settings to systems.

Returnosid.control.SettingSystemAssignmentSession a SettingSystemAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSettingSystemAssignment() is false
Complianceoptional This method must be implemented if supportsSettingSystemAssignment() is true.
MethodgetSettingSmartSystemSession
Description

Gets the OsidSession to manage locatin smart systems.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.SettingSmartSystemSession a SettingSmartSystemSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSettingSmartSystem() is false
Complianceoptional This method must be implemented if supportsSettingSmartSystem() is true.
MethodgetSceneLookupSession
Description

Gets the OsidSession associated with the scene lookup service.

Returnosid.control.SceneLookupSession a SceneLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSceneLookup() is false
Complianceoptional This method must be implemented if supportsSceneLookup() is true.
MethodgetSceneLookupSessionForSystem
Description

Gets the OsidSession associated with the scene lookup service for the given system.

Parametersosid.id.IdsystemId the Id of the system
Returnosid.control.SceneLookupSession a SceneLookupSession
ErrorsNOT_FOUND no System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSceneLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsSceneLookup() and supportsVisibleFederation() are true
MethodgetSceneQuerySession
Description

Gets the OsidSession associated with the scene query service.

Returnosid.control.SceneQuerySession a SceneQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSceneQuery() is false
Complianceoptional This method must be implemented if supportsSceneQuery() is true.
MethodgetSceneQuerySessionForSystem
Description

Gets the OsidSession associated with the scene query service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.SceneQuerySession a SceneQuerySession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSceneQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsSceneQuery() and supportsVisibleFederation() are true
MethodgetSceneSearchSession
Description

Gets the OsidSession associated with the scene search service.

Returnosid.control.SceneSearchSession a SceneSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSceneSearch() is false
Complianceoptional This method must be implemented if supportsSceneSearch() is true.
MethodgetSceneSearchSessionForSystem
Description

Gets the OsidSession associated with the scene search service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.SceneSearchSession a SceneSearchSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSceneSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsSceneSearch() and supportsVisibleFederation() are true
MethodgetSceneAdminSession
Description

Gets the OsidSession associated with the scene administration service.

Returnosid.control.SceneAdminSession a SceneAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSceneAdmin() is false
Complianceoptional This method must be implemented if supportsSceneAdmin() is true.
MethodgetSceneAdminSessionForSystem
Description

Gets the OsidSession associated with the scene administration service for the given system.

Parametersosid.id.IdsystemId the Id of the Dostributor
Returnosid.control.SceneAdminSession a SceneAdminSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSceneAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsSceneAdmin() and supportsVisibleFederation() are true
MethodgetSceneNotificationSession
Description

Gets the OsidSession associated with the scene notification service.

Parametersosid.control.SceneReceiversceneReceiver the notification callback
Returnosid.control.SceneNotificationSession a SceneNotificationSession
ErrorsNULL_ARGUMENT sceneReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSceneNotification() is false
Complianceoptional This method must be implemented if supportsSceneNotification() is true.
MethodgetSceneNotificationSessionForSystem
Description

Gets the OsidSession associated with the scene notification service for the given system.

Parametersosid.control.SceneReceiversceneReceiver the notification callback
osid.id.IdsystemId the Id of the System
Returnosid.control.SceneNotificationSession a SceneNotificationSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT sceneReceiver or systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSceneNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsSceneNotification() and supportsVisibleFederation() are true
MethodgetSceneSystemSession
Description

Gets the OsidSession to lookup scene/system mappings.

Returnosid.control.SceneSystemSession a SceneSystemSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSceneSystem() is false
Complianceoptional This method must be implemented if supportsSceneSystem() is true.
MethodgetSceneSystemAssignmentSession
Description

Gets the OsidSession associated with assigning scenes to systems.

Returnosid.control.SceneSystemAssignmentSession a SceneSystemAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSceneSystemAssignment() is false
Complianceoptional This method must be implemented if supportsSceneSystemAssignment() is true.
MethodgetSceneSmartSystemSession
Description

Gets the OsidSession to manage locatin smart systems.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.SceneSmartSystemSession a SceneSmartSystemSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSceneSmartSystem() is false
Complianceoptional This method must be implemented if supportsSceneSmartSystem() is true.
MethodgetTriggerLookupSession
Description

Gets the OsidSession associated with the trigger lookup service.

Returnosid.control.TriggerLookupSession a TriggerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTriggerLookup() is false
Complianceoptional This method must be implemented if supportsTriggerLookup() is true.
MethodgetTriggerLookupSessionForSystem
Description

Gets the OsidSession associated with the trigger lookup service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.TriggerLookupSession a TriggerLookupSession
ErrorsNOT_FOUND no System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTriggerLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsTriggerLookup() and supportsVisibleFederation() are true
MethodgetTriggerQuerySession
Description

Gets the OsidSession associated with the trigger query service.

Returnosid.control.TriggerQuerySession a TriggerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTriggerQuery() is false
Complianceoptional This method must be implemented if supportsTriggerQuery() is true.
MethodgetTriggerQuerySessionForSystem
Description

Gets the OsidSession associated with the trigger query service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.TriggerQuerySession a TriggerQuerySession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTriggerQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsTriggerQuery() and supportsVisibleFederation() are true
MethodgetTriggerSearchSession
Description

Gets the OsidSession associated with the trigger search service.

Returnosid.control.TriggerSearchSession a TriggerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTriggerSearch() is false
Complianceoptional This method must be implemented if supportsTriggerSearch() is true.
MethodgetTriggerSearchSessionForSystem
Description

Gets the OsidSession associated with the trigger search service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.TriggerSearchSession a TriggerSearchSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTriggerSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsTriggerSearch() and supportsVisibleFederation() are true
MethodgetTriggerAdminSession
Description

Gets the OsidSession associated with the trigger administration service.

Returnosid.control.TriggerAdminSession a TriggerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTriggerAdmin() is false
Complianceoptional This method must be implemented if supportsTriggerAdmin() is true.
MethodgetTriggerAdminSessionForSystem
Description

Gets the OsidSession associated with the trigger administration service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.TriggerAdminSession a TriggerAdminSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTriggerAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsTriggerAdmin() and supportsVisibleFederation() are true
MethodgetTriggerNotificationSession
Description

Gets the OsidSession associated with the trigger notification service.

Parametersosid.control.TriggerReceivertriggerReceiver the notification callback
Returnosid.control.TriggerNotificationSession a TriggerNotificationSession
ErrorsNULL_ARGUMENT triggerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTriggerNotification() is false
Complianceoptional This method must be implemented if supportsTriggerNotification() is true.
MethodgetTriggerNotificationSessionForSystem
Description

Gets the OsidSession associated with the trigger notification service for the given system.

Parametersosid.control.TriggerReceivertriggerReceiver the notification callback
osid.id.IdsystemId the Id of the System
Returnosid.control.TriggerNotificationSession a TriggerNotificationSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT triggerReceiver or systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTriggerNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsTriggerNotification() and supportsVisibleFederation() are true
MethodgetTriggerSystemSession
Description

Gets the OsidSession to lookup trigger/system mappings.

Returnosid.control.TriggerSystemSession a TriggerSystemSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTriggerSystem() is false
Complianceoptional This method must be implemented if supportsTriggerSystem() is true.
MethodgetTriggerSystemAssignmentSession
Description

Gets the OsidSession associated with assigning triggers to systems.

Returnosid.control.TriggerSystemAssignmentSession a TriggerSystemAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTriggerSystemAssignment() is false
Complianceoptional This method must be implemented if supportsTriggerSystemAssignment() is true.
MethodgetTriggerSmartSystemSession
Description

Gets the OsidSession to manage trigger smart systems.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.TriggerSmartSystemSession a TriggerSmartSystemSession
ErrorsNOT_FOUND no System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsTriggerSmartSystem() is false
Complianceoptional This method must be implemented if supportsTriggerSmartSystem() is true.
MethodgetActionGroupLookupSession
Description

Gets the OsidSession associated with the action group lookup service.

Returnosid.control.ActionGroupLookupSession an ActionGroupLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActionGroupLookup() is false
Complianceoptional This method must be implemented if supportsActionGroupLookup() is true.
MethodgetActionGroupLookupSessionForSystem
Description

Gets the OsidSession associated with the action group lookup service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.ActionGroupLookupSession an ActionGroupLookupSession
ErrorsNOT_FOUND no System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActionGroupLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsActionGroupLookup() and supportsVisibleFederation() are true
MethodgetActionGroupQuerySession
Description

Gets the OsidSession associated with the action group query service.

Returnosid.control.ActionGroupQuerySession an ActionGroupQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActionGroupQuery() is false
Complianceoptional This method must be implemented if supportsActionGroupQuery() is true.
MethodgetActionGroupQuerySessionForSystem
Description

Gets the OsidSession associated with the action group query service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.ActionGroupQuerySession an ActionGroupQuerySession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActionGroupQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsActionGroupQuery() and supportsVisibleFederation() are true
MethodgetActionGroupSearchSession
Description

Gets the OsidSession associated with the action group search service.

Returnosid.control.ActionGroupSearchSession an ActionGroupSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActionGroupSearch() is false
Complianceoptional This method must be implemented if supportsActionGroupSearch() is true.
MethodgetActionGroupSearchSessionForSystem
Description

Gets the OsidSession associated with the action group search service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.ActionGroupSearchSession an ActionGroupSearchSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActionGroupSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsActionGroupSearch() and supportsVisibleFederation() are true
MethodgetActionGroupAdminSession
Description

Gets the OsidSession associated with the action group administration service.

Returnosid.control.ActionGroupAdminSession an ActionGroupAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActionGroupAdmin() is false
Complianceoptional This method must be implemented if supportsActionGroupAdmin() is true.
MethodgetActionGroupAdminSessionForSystem
Description

Gets the OsidSession associated with the action group administration service for the given system.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.ActionGroupAdminSession an ActionGroupAdminSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActionGroupAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsActionGroupAdmin() and supportsVisibleFederation() are true
MethodgetActionGroupNotificationSession
Description

Gets the OsidSession associated with the action group notification service.

Parametersosid.control.ActionGroupReceiveractionGroupReceiver the notification callback
Returnosid.control.ActionGroupNotificationSession an ActionGroupNotificationSession
ErrorsNULL_ARGUMENT actionGroupReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActionGroupNotification() is false
Complianceoptional This method must be implemented if supportsActionGroupNotification() is true.
MethodgetActionGroupNotificationSessionForSystem
Description

Gets the OsidSession associated with the action group notification service for the given system.

Parametersosid.control.ActionGroupReceiveractionGroupReceiver the notification callback
osid.id.IdsystemId the Id of the System
Returnosid.control.ActionGroupNotificationSession an ActionGroupNotificationSession
ErrorsNOT_FOUND no system found by the given Id
NULL_ARGUMENT actionGroupReceiver or systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActionGroupNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsActionGroupNotification() and supportsVisibleFederation() are true
MethodgetActionGroupSystemSession
Description

Gets the OsidSession to lookup action group/system mappings.

Returnosid.control.ActionGroupSystemSession an ActionGroupSystemSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActionGroupSystem() is false
Complianceoptional This method must be implemented if supportsActionGroupSystem() is true.
MethodgetActionGroupSystemAssignmentSession
Description

Gets the OsidSession associated with assigning action groups to systems.

Returnosid.control.ActionGroupSystemAssignmentSession an ActionGroupSystemAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActionGroupSystemAssignment() is false
Complianceoptional This method must be implemented if supportsActionGroupSystemAssignment() is true.
MethodgetActionGroupSmartSystemSession
Description

Gets the OsidSession to manage action group smart systems.

Parametersosid.id.IdsystemId the Id of the System
Returnosid.control.ActionGroupSmartSystemSession an ActionGroupSmartSystemSession
ErrorsNOT_FOUND no System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActionGroupSmartSystem() is false
Complianceoptional This method must be implemented if supportsActionGroupSmartSystem() is true.
MethodgetSystemLookupSession
Description

Gets the OsidSession associated with the system lookup service.

Returnosid.control.SystemLookupSession a SystemLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSystemLookup() is false
Complianceoptional This method must be implemented if supportsSystemLookup() is true.
MethodgetSystemQuerySession
Description

Gets the OsidSession associated with the system query service.

Returnosid.control.SystemQuerySession a SystemQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSystemQuery() is false
Complianceoptional This method must be implemented if supportsSystemQuery() is true.
MethodgetSystemSearchSession
Description

Gets the OsidSession associated with the system search service.

Returnosid.control.SystemSearchSession a SystemSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSystemSearch() is false
Complianceoptional This method must be implemented if supportsSystemSearch() is true.
MethodgetSystemAdminSession
Description

Gets the OsidSession associated with the system administrative service.

Returnosid.control.SystemAdminSession a SystemAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSystemAdmin() is false
Complianceoptional This method must be implemented if supportsSystemAdmin() is true.
MethodgetSystemNotificationSession
Description

Gets the OsidSession associated with the system notification service.

Parametersosid.control.SystemReceiversystemReceiver the notification callback
Returnosid.control.SystemNotificationSession a SystemNotificationSession
ErrorsNULL_ARGUMENT systemReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSystemNotification() is false
Complianceoptional This method must be implemented if supportsSystemNotification() is true.
MethodgetSystemHierarchySession
Description

Gets the OsidSession associated with the system hierarchy service.

Returnosid.control.SystemHierarchySession a SystemHierarchySession for systems
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSystemHierarchy() is false
Complianceoptional This method must be implemented if supportsSystemHierarchy() is true.
MethodgetSystemHierarchyDesignSession
Description

Gets the OsidSession associated with the system hierarchy design service.

Returnosid.control.SystemHierarchyDesignSession a HierarchyDesignSession for systems
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSystemHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsSystemHierarchyDesign() is true.
MethodgetControlBatchManager
Description

Gets the ControlBatchManager.

Returnosid.control.batch.ControlBatchManager a ControlBatchManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControlBatch() is false
Complianceoptional This method must be implemented if supportsControlBatch() is true.
MethodgetControlRulesManager
Description

Gets the ControlRulesManager.

Returnosid.control.rules.ControlRulesManager a ControlRulesManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsControlRules() is false
Complianceoptional This method must be implemented if supportsControlRules() is true.