OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.ControlProxyManager
Implementsosid.OsidProxyManager
osid.control.ControlProfile
Description

The control proxy manager provides access to control sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.DeviceLookupSessiona DeviceLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceLookup() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.DeviceLookupSessiona DeviceLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDeviceLookup() and supportsVisibleFederation() are true
MethodgetDeviceQuerySession
Description

Gets the OsidSession associated with the device query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.DeviceQuerySessiona DeviceQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceQuery() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.DeviceQuerySessiona DeviceQuerySession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDeviceQuery() and supportsVisibleFederation() are true
MethodgetDeviceSearchSession
Description

Gets the OsidSession associated with the device search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.DeviceSearchSessiona DeviceSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceSearch() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.DeviceSearchSessiona DeviceSearchSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDeviceSearch() and supportsVisibleFederation() are true
MethodgetDeviceAdminSession
Description

Gets the OsidSession associated with the device administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.DeviceAdminSessiona DeviceAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceAdmin() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the system
osid.proxy.Proxyproxya proxy
Returnosid.control.DeviceAdminSessiona DeviceAdminSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDeviceAdmin() and supportsVisibleFederation() are true
MethodgetDeviceNotificationSession
Description

Gets the OsidSession associated with the device notification service.

Parametersosid.control.DeviceReceiverdeviceReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.control.DeviceNotificationSessiona DeviceNotificationSession
ErrorsNULL_ARGUMENT deviceReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceNotification() is false
ComplianceoptionalThis 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.DeviceReceiverdeviceReceiverthe notification callback
osid.id.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.DeviceNotificationSessiona DeviceNotificationSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT deviceReceiver, systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDeviceNotification() and supportsVisibleFederation() are true
MethodgetDeviceSystemSession
Description

Gets the OsidSession to lookup device/system mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.DeviceSystemSessiona DeviceSystemSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceSystem() is false
ComplianceoptionalThis method must be implemented if supportsDeviceSystem() is true.
MethodgetDeviceSystemAssignmentSession
Description

Gets the OsidSession associated with assigning devices to systems.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.DeviceSystemAssignmentSessiona DeviceSystemAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceSystemAssignment() is false
ComplianceoptionalThis method must be implemented if supportsDeviceSystemAssignment() is true.
MethodgetDeviceSmartSystemSession
Description

Gets the OsidSession to manage device smart systems.

Parametersosid.id.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.DeviceSmartSystemSessiona DeviceSmartSystemSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceSmartSystem() is false
ComplianceoptionalThis method must be implemented if supportsDeviceSmartSystem() is true.
MethodgetControllerLookupSession
Description

Gets the OsidSession associated with the controller lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.ControllerLookupSessiona ControllerLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControllerLookup() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.ControllerLookupSessiona ControllerLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControllerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsControllerLookup() and supportsVisibleFederation() are true
MethodgetControllerQuerySession
Description

Gets the OsidSession associated with the controller query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.ControllerQuerySessiona ControllerQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControllerQuery() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.ControllerQuerySessiona ControllerQuerySession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControllerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsControllerQuery() and supportsVisibleFederation() are true
MethodgetControllerSearchSession
Description

Gets the OsidSession associated with the controller search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.ControllerSearchSessiona ControllerSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControllerSearch() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.ControllerSearchSessiona ControllerSearchSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControllerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsControllerSearch() and supportsVisibleFederation() are true
MethodgetControllerAdminSession
Description

Gets the OsidSession associated with the controller administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.ControllerAdminSessiona ControllerAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControllerAdmin() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the system
osid.proxy.Proxyproxya proxy
Returnosid.control.ControllerAdminSessiona ControllerAdminSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControllerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsControllerAdmin() and supportsVisibleFederation() are true
MethodgetControllerNotificationSession
Description

Gets the OsidSession associated with the controller notification service.

Parametersosid.control.ControllerReceivercontrollerReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.control.ControllerNotificationSessiona ControllerNotificationSession
ErrorsNULL_ARGUMENT controllerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControllerNotification() is false
ComplianceoptionalThis 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.ControllerReceivercontrollerReceiverthe notification callback
osid.id.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.ControllerNotificationSessiona ControllerNotificationSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT controllerReceiver, systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControllerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsControllerNotification() and supportsVisibleFederation() are true
MethodgetControllerSystemSession
Description

Gets the OsidSession to lookup controller/system mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.ControllerSystemSessiona ControllerSystemSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControllerSystem() is false
ComplianceoptionalThis method must be implemented if supportsControllerSystem() is true.
MethodgetControllerSystemAssignmentSession
Description

Gets the OsidSession associated with assigning controllers to systems.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.ControllerSystemAssignmentSessiona ControllerSystemAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControllerSystemAssignment() is false
ComplianceoptionalThis method must be implemented if supportsControllerSystemAssignment() is true.
MethodgetControllerSmartSystemSession
Description

Gets the OsidSession to manage controller smart systems.

Parametersosid.id.IdsystemIdthe Id of the system
osid.proxy.Proxyproxya proxy
Returnosid.control.ControllerSmartSystemSessiona ControllerSmartSystemSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControllerSmartSystem() is false
ComplianceoptionalThis method must be implemented if supportsControllerSmartSystem() is true.
MethodgetInputLookupSession
Description

Gets the OsidSession associated with the input lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.InputLookupSessionan InputLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputLookup() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.InputLookupSessionan InputLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInputLookup() and supportsVisibleFederation() are true.
MethodgetInputQuerySession
Description

Gets the OsidSession associated with the input query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.InputQuerySessionan InputQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputQuery() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.InputQuerySessionan InputQuerySession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInputQuery() and supportsVisibleFederation() are true.
MethodgetInputSearchSession
Description

Gets the OsidSession associated with the input search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.InputSearchSessionan InputSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputSearch() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.InputSearchSessionan InputSearchSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInputSearch() and supportsVisibleFederation() are true
MethodgetInputAdminSession
Description

Gets the OsidSession associated with the input administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.InputAdminSessionan InputAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputAdmin() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the system
osid.proxy.Proxyproxya proxy
Returnosid.control.InputAdminSessionan InputAdminSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInputAdmin() and supportsVisibleFederation() are true
MethodgetInputNotificationSession
Description

Gets the OsidSession associated with the input notification service.

Parametersosid.control.InputReceiverinputReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.control.InputNotificationSessionan InputNotificationSession
ErrorsNULL_ARGUMENT inputReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputNotification() is false
ComplianceoptionalThis 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.InputReceiverinputReceiverthe notification callback
osid.id.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.InputNotificationSessionan InputNotificationSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT inputReceiver, systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInputNotification() and supportsVisibleFederation() are true.
MethodgetInputSystemSession
Description

Gets the OsidSession to lookup input/system mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.InputSystemSessionan InputSystemSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputSystem() is false
ComplianceoptionalThis method must be implemented if supportsInputSystem() is true.
MethodgetInputSystemAssignmentSession
Description

Gets the OsidSession associated with assigning inputs to systems.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.InputSystemAssignmentSessionan InputSystemAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputSystemAssignment() is false
ComplianceoptionalThis method must be implemented if supportsInputSystemAssignment() is true.
MethodgetInputSmartSystemSession
Description

Gets the OsidSession to manage input smart systems.

Parametersosid.id.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.InputSmartSystemSessionan InputSmartSystemSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputSmartSystem() is false
ComplianceoptionalThis method must be implemented if supportsInputSmartSystem() is true.
MethodgetSettingLookupSession
Description

Gets the OsidSession associated with the setting lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SettingLookupSessiona SettingLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSettingLookup() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the system
osid.proxy.Proxyproxya proxy
Returnosid.control.SettingLookupSessiona SettingLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSettingLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSettingLookup() and supportsVisibleFederation() are true.
MethodgetSettingQuerySession
Description

Gets the OsidSession associated with the setting query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SettingQuerySessiona SettingQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSettingQuery() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.SettingQuerySessiona SettingQuerySession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSettingQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSettingQuery() and supportsVisibleFederation() are true.
MethodgetSettingSearchSession
Description

Gets the OsidSession associated with the setting search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SettingSearchSessiona SettingSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSettingSearch() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.SettingSearchSessiona SettingSearchSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSettingSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSettingSearch() and supportsVisibleFederation() are true.
MethodgetSettingAdminSession
Description

Gets the OsidSession associated with the setting administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SettingAdminSessiona SettingAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSettingAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSettingAdmin() is true.
MethodgetSettingAdminSessionForInput
Description

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

Parametersosid.id.IdinputIdthe Id of the Input
osid.proxy.Proxyproxya proxy
Returnosid.control.SettingAdminSessiona SettingAdminSession
ErrorsNOT_FOUNDno input found by the given Id
NULL_ARGUMENT inputId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSettingAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSettingAdmin() and supportsVisibleFederation() are true.
MethodgetSettingNotificationSession
Description

Gets the OsidSession associated with the setting notification service.

Parametersosid.control.SettingReceiversettingReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.control.SettingNotificationSessiona SettingNotificationSession
ErrorsNULL_ARGUMENT settingReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSettingNotification() is false
ComplianceoptionalThis 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.SettingReceiversettingReceiverthe notification callback
osid.id.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.SettingNotificationSessiona SettingNotificationSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT settingReceiver, systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSettingNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSettingNotification() and supportsVisibleFederation() are true.
MethodgetSettingSystemSession
Description

Gets the OsidSession to lookup setting/system mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SettingSystemSessiona SettingSystemSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSettingSystem() is false
ComplianceoptionalThis method must be implemented if supportsSettingSystem() is true.
MethodgetSettingSystemAssignmentSession
Description

Gets the OsidSession associated with assigning settings to systems.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SettingSystemAssignmentSessiona SettingSystemAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSettingSystemAssignment() is false
ComplianceoptionalThis method must be implemented if supportsSettingSystemAssignment() is true.
MethodgetSettingSmartSystemSession
Description

Gets the OsidSession to manage locatin smart systems.

Parametersosid.id.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.SettingSmartSystemSessiona SettingSmartSystemSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSettingSmartSystem() is false
ComplianceoptionalThis method must be implemented if supportsSettingSmartSystem() is true.
MethodgetSceneLookupSession
Description

Gets the OsidSession associated with the scene lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SceneLookupSessiona SceneLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSceneLookup() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the system
osid.proxy.Proxyproxya proxy
Returnosid.control.SceneLookupSessiona SceneLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSceneLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSceneLookup() and supportsVisibleFederation() are true.
MethodgetSceneQuerySession
Description

Gets the OsidSession associated with the scene query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SceneQuerySessiona SceneQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSceneQuery() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.SceneQuerySessiona SceneQuerySession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSceneQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSceneQuery() and supportsVisibleFederation() are true.
MethodgetSceneSearchSession
Description

Gets the OsidSession associated with the scene search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SceneSearchSessiona SceneSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSceneSearch() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.SceneSearchSessiona SceneSearchSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSceneSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSceneSearch() and supportsVisibleFederation() are true.
MethodgetSceneAdminSession
Description

Gets the OsidSession associated with the scene administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SceneAdminSessiona SceneAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSceneAdmin() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.SceneAdminSessiona SceneAdminSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSceneAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSceneAdmin() and supportsVisibleFederation() are true.
MethodgetSceneNotificationSession
Description

Gets the OsidSession associated with the scene notification service.

Parametersosid.control.SceneReceiversceneReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.control.SceneNotificationSessiona SceneNotificationSession
ErrorsNULL_ARGUMENT sceneReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSceneNotification() is false
ComplianceoptionalThis 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.SceneReceiversceneReceiverthe notification callback
osid.id.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.SceneNotificationSessiona SceneNotificationSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT sceneReceiver, systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSceneNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSceneNotification() and supportsVisibleFederation() are true.
MethodgetSceneSystemSession
Description

Gets the OsidSession to lookup scene/system mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SceneSystemSessiona SceneSystemSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSceneSystem() is false
ComplianceoptionalThis method must be implemented if supportsSceneSystem() is true.
MethodgetSceneSystemAssignmentSession
Description

Gets the OsidSession associated with assigning scenes to systems.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SceneSystemAssignmentSessiona SceneSystemAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSceneSystemAssignment() is false
ComplianceoptionalThis method must be implemented if supportsSceneSystemAssignment() is true.
MethodgetSceneSmartSystemSession
Description

Gets the OsidSession to manage locatin smart systems.

Parametersosid.id.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.SceneSmartSystemSessiona SceneSmartSystemSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSceneSmartSystem() is false
ComplianceoptionalThis method must be implemented if supportsSceneSmartSystem() is true.
MethodgetTriggerLookupSession
Description

Gets the OsidSession associated with the trigger lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.TriggerLookupSessiona TriggerLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerLookup() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.TriggerLookupSessiona TriggerLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTriggerLookup() and supportsVisibleFederation() are true
MethodgetTriggerQuerySession
Description

Gets the OsidSession associated with the trigger query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.TriggerQuerySessiona TriggerQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerQuery() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.TriggerQuerySessiona TriggerQuerySession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTriggerQuery() and supportsVisibleFederation() are true
MethodgetTriggerSearchSession
Description

Gets the OsidSession associated with the trigger search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.TriggerSearchSessiona TriggerSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerSearch() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.TriggerSearchSessiona TriggerSearchSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTriggerSearch() and supportsVisibleFederation() are true
MethodgetTriggerAdminSession
Description

Gets the OsidSession associated with the trigger administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.TriggerAdminSessiona TriggerAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerAdmin() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.TriggerAdminSessiona TriggerAdminSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTriggerAdmin() and supportsVisibleFederation() are true
MethodgetTriggerNotificationSession
Description

Gets the OsidSession associated with the trigger notification service.

Parametersosid.control.TriggerReceivertriggerReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.control.TriggerNotificationSessiona TriggerNotificationSession
ErrorsNULL_ARGUMENT triggerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerNotification() is false
ComplianceoptionalThis 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.TriggerReceivertriggerReceiverthe notification callback
osid.id.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.TriggerNotificationSessiona TriggerNotificationSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT triggerReceiver, systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTriggerNotification() and supportsVisibleFederation() are true
MethodgetTriggerSystemSession
Description

Gets the OsidSession to lookup trigger/system mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.TriggerSystemSessiona TriggerSystemSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerSystem() is false
ComplianceoptionalThis method must be implemented if supportsTriggerSystem() is true.
MethodgetTriggerSystemAssignmentSession
Description

Gets the OsidSession associated with assigning triggers to systems.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.TriggerSystemAssignmentSessiona TriggerSystemAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerSystemAssignment() is false
ComplianceoptionalThis method must be implemented if supportsTriggerSystemAssignment() is true.
MethodgetTriggerSmartSystemSession
Description

Gets the OsidSession to manage trigger smart systems.

Parametersosid.id.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.TriggerSmartSystemSessiona TriggerSmartSystemSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerSmartSystem() is false
ComplianceoptionalThis method must be implemented if supportsTriggerSmartSystem() is true.
MethodgetActionGroupLookupSession
Description

Gets the OsidSession associated with the action group lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.ActionGroupLookupSessionan ActionGroupLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionGroupLookup() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.ActionGroupLookupSessionan ActionGroupLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionGroupLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsActionGroupLookup() and supportsVisibleFederation() are true
MethodgetActionGroupQuerySession
Description

Gets the OsidSession associated with the action group query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.ActionGroupQuerySessionan ActionGroupQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionGroupQuery() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.ActionGroupQuerySessionan ActionGroupQuerySession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionGroupQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsActionGroupQuery() and supportsVisibleFederation() are true
MethodgetActionGroupSearchSession
Description

Gets the OsidSession associated with the action group search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.ActionGroupSearchSessionan ActionGroupSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionGroupSearch() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.ActionGroupSearchSessionan ActionGroupSearchSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionGroupSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsActionGroupSearch() and supportsVisibleFederation() are true
MethodgetActionGroupAdminSession
Description

Gets the OsidSession associated with the action group administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.ActionGroupAdminSessionan ActionGroupAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionGroupAdmin() is false
ComplianceoptionalThis 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.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.ActionGroupAdminSessionan ActionGroupAdminSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionGroupAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsActionGroupAdmin() and supportsVisibleFederation() are true
MethodgetActionGroupNotificationSession
Description

Gets the OsidSession associated with the action group notification service.

Parametersosid.control.ActionGroupReceiveractionGroupReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.control.ActionGroupNotificationSessionan ActionGroupNotificationSession
ErrorsNULL_ARGUMENT actionGroupReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionGroupNotification() is false
ComplianceoptionalThis 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.ActionGroupReceiveractionGroupReceiverthe notification callback
osid.id.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.ActionGroupNotificationSessionan ActionGroupNotificationSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT actionGroupReceiver, systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionGroupNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsActionGroupNotification() and supportsVisibleFederation() are true
MethodgetActionGroupSystemSession
Description

Gets the OsidSession to lookup action group/system mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.ActionGroupSystemSessionan ActionGroupSystemSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionGroupSystem() is false
ComplianceoptionalThis method must be implemented if supportsActionGroupSystem() is true.
MethodgetActionGroupSystemAssignmentSession
Description

Gets the OsidSession associated with assigning action groups to systems.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.ActionGroupSystemAssignmentSessionan ActionGroupSystemAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionGroupSystemAssignment() is false
ComplianceoptionalThis method must be implemented if supportsActionGroupSystemAssignment() is true.
MethodgetActionGroupSmartSystemSession
Description

Gets the OsidSession to manage action group smart systems.

Parametersosid.id.IdsystemIdthe Id of the System
osid.proxy.Proxyproxya proxy
Returnosid.control.ActionGroupSmartSystemSessionan ActionGroupSmartSystemSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT systemId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionGroupSmartSystem() is false
ComplianceoptionalThis method must be implemented if supportsActionGroupSmartSystem() is true.
MethodgetSystemLookupSession
Description

Gets the OsidSession associated with the system lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SystemLookupSessiona SystemLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSystemLookup() is false
ComplianceoptionalThis method must be implemented if supportsSystemLookup() is true.
MethodgetSystemQuerySession
Description

Gets the OsidSession associated with the system query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SystemQuerySessiona SystemQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSystemQuery() is false
ComplianceoptionalThis method must be implemented if supportsSystemQuery() is true.
MethodgetSystemSearchSession
Description

Gets the OsidSession associated with the system search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SystemSearchSessiona SystemSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSystemSearch() is false
ComplianceoptionalThis method must be implemented if supportsSystemSearch() is true.
MethodgetSystemAdminSession
Description

Gets the OsidSession associated with the system administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SystemAdminSessiona SystemAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSystemAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSystemAdmin() is true.
MethodgetSystemNotificationSession
Description

Gets the OsidSession associated with the system notification service.

Parametersosid.control.SystemReceiversystemReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.control.SystemNotificationSessiona SystemNotificationSession
ErrorsNULL_ARGUMENT systemReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSystemNotification() is false
ComplianceoptionalThis method must be implemented if supportsSystemNotification() is true.
MethodgetSystemHierarchySession
Description

Gets the OsidSession associated with the system hierarchy service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SystemHierarchySessiona SystemHierarchySession for systems
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSystemHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsSystemHierarchy() is true.
MethodgetSystemHierarchyDesignSession
Description

Gets the OsidSession associated with the system hierarchy design service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.control.SystemHierarchyDesignSessiona HierarchyDesignSession for systems
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSystemHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsSystemHierarchyDesign() is true.
MethodgetControlBatchProxyManager
Description

Gets the ControlBatchProxyManager.

Returnosid.control.batch.ControlBatchProxyManagera ControlBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControlBatch() is false
ComplianceoptionalThis method must be implemented if supportsControlBatch() is true.
MethodgetControlRulesProxyManager
Description

Gets the ControlRulesProxyManager.

Returnosid.control.rules.ControlRulesProxyManagera ControlRulesProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsControlRules() is false
ComplianceoptionalThis method must be implemented if supportsControlRules() is true.