org.osid.control

Interface ControlProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ControlProfile, OsidProfile, OsidProxyManager, Sourceable

public interface ControlProxyManager
extends OsidProxyManager, ControlProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
ActionGroupAdminSession	getActionGroupAdminSession(Proxy proxy) Gets the OsidSession associated with the action group administration service.
ActionGroupAdminSession	getActionGroupAdminSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the action group administration service for the given system.
ActionGroupLookupSession	getActionGroupLookupSession(Proxy proxy) Gets the OsidSession associated with the action group lookup service.
ActionGroupLookupSession	getActionGroupLookupSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the action group lookup service for the given system.
ActionGroupNotificationSession	getActionGroupNotificationSession(ActionGroupReceiver actionGroupReceiver, Proxy proxy) Gets the OsidSession associated with the action group notification service.
ActionGroupNotificationSession	getActionGroupNotificationSessionForSystem(ActionGroupReceiver actionGroupReceiver, Id systemId, Proxy proxy) Gets the OsidSession associated with the action group notification service for the given system.
ActionGroupQuerySession	getActionGroupQuerySession(Proxy proxy) Gets the OsidSession associated with the action group query service.
ActionGroupQuerySession	getActionGroupQuerySessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the action group query service for the given system.
ActionGroupSearchSession	getActionGroupSearchSession(Proxy proxy) Gets the OsidSession associated with the action group search service.
ActionGroupSearchSession	getActionGroupSearchSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the action group search service for the given system.
ActionGroupSmartSystemSession	getActionGroupSmartSystemSession(Id systemId, Proxy proxy) Gets the OsidSession to manage action group smart systems.
ActionGroupSystemAssignmentSession	getActionGroupSystemAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning action groups to systems.
ActionGroupSystemSession	getActionGroupSystemSession(Proxy proxy) Gets the OsidSession to lookup action group/system mappings.
ControlBatchProxyManager	getControlBatchProxyManager() Gets the ControlBatchProxyManager.
ControllerAdminSession	getControllerAdminSession(Proxy proxy) Gets the OsidSession associated with the controller administration service.
ControllerAdminSession	getControllerAdminSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the controller administration service for the given system.
ControllerLookupSession	getControllerLookupSession(Proxy proxy) Gets the OsidSession associated with the controller lookup service.
ControllerLookupSession	getControllerLookupSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the controller lookup service for the given system.
ControllerNotificationSession	getControllerNotificationSession(ControllerReceiver controllerReceiver, Proxy proxy) Gets the OsidSession associated with the controller notification service.
ControllerNotificationSession	getControllerNotificationSessionForSystem(ControllerReceiver controllerReceiver, Id systemId, Proxy proxy) Gets the OsidSession associated with the controller notification service for the given system.
ControllerQuerySession	getControllerQuerySession(Proxy proxy) Gets the OsidSession associated with the controller query service.
ControllerQuerySession	getControllerQuerySessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the controller query service for the given system.
ControllerSearchSession	getControllerSearchSession(Proxy proxy) Gets the OsidSession associated with the controller search service.
ControllerSearchSession	getControllerSearchSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the controller search service for the given system.
ControllerSmartSystemSession	getControllerSmartSystemSession(Id systemId, Proxy proxy) Gets the OsidSession to manage controller smart systems.
ControllerSystemAssignmentSession	getControllerSystemAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning controllers to systems.
ControllerSystemSession	getControllerSystemSession(Proxy proxy) Gets the OsidSession to lookup controller/system mappings.
ControlRulesProxyManager	getControlRulesProxyManager() Gets the ControlRulesProxyManager.
DeviceAdminSession	getDeviceAdminSession(Proxy proxy) Gets the OsidSession associated with the device administration service.
DeviceAdminSession	getDeviceAdminSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the device administration service for the given system.
DeviceLookupSession	getDeviceLookupSession(Proxy proxy) Gets the OsidSession associated with the device lookup service.
DeviceLookupSession	getDeviceLookupSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the device lookup service for the given system.
DeviceNotificationSession	getDeviceNotificationSession(DeviceReceiver deviceReceiver, Proxy proxy) Gets the OsidSession associated with the device notification service.
DeviceNotificationSession	getDeviceNotificationSessionForSystem(DeviceReceiver deviceReceiver, Id systemId, Proxy proxy) Gets the OsidSession associated with the device notification service for the given system.
DeviceQuerySession	getDeviceQuerySession(Proxy proxy) Gets the OsidSession associated with the device query service.
DeviceQuerySession	getDeviceQuerySessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the device query service for the given system.
DeviceSearchSession	getDeviceSearchSession(Proxy proxy) Gets the OsidSession associated with the device search service.
DeviceSearchSession	getDeviceSearchSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the device search service for the given system.
DeviceSmartSystemSession	getDeviceSmartSystemSession(Id systemId, Proxy proxy) Gets the OsidSession to manage device smart systems.
DeviceSystemAssignmentSession	getDeviceSystemAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning devices to systems.
DeviceSystemSession	getDeviceSystemSession(Proxy proxy) Gets the OsidSession to lookup device/system mappings.
InputAdminSession	getInputAdminSession(Proxy proxy) Gets the OsidSession associated with the input administration service.
InputAdminSession	getInputAdminSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the input administration service for the given system.
InputLookupSession	getInputLookupSession(Proxy proxy) Gets the OsidSession associated with the input lookup service.
InputLookupSession	getInputLookupSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the input lookup service for the given system.
InputNotificationSession	getInputNotificationSession(InputReceiver inputReceiver, Proxy proxy) Gets the OsidSession associated with the input notification service.
InputNotificationSession	getInputNotificationSessionForSystem(InputReceiver inputReceiver, Id systemId, Proxy proxy) Gets the OsidSession associated with the input notification service for the given system.
InputQuerySession	getInputQuerySession(Proxy proxy) Gets the OsidSession associated with the input query service.
InputQuerySession	getInputQuerySessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the input query service for the given system.
InputSearchSession	getInputSearchSession(Proxy proxy) Gets the OsidSession associated with the input search service.
InputSearchSession	getInputSearchSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the input search service for the given system.
InputSmartSystemSession	getInputSmartSystemSession(Id systemId, Proxy proxy) Gets the OsidSession to manage input smart systems.
InputSystemAssignmentSession	getInputSystemAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning inputs to systems.
InputSystemSession	getInputSystemSession(Proxy proxy) Gets the OsidSession to lookup input/system mappings.
SceneAdminSession	getSceneAdminSession(Proxy proxy) Gets the OsidSession associated with the scene administration service.
SceneAdminSession	getSceneAdminSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the scene administration service for the given system.
SceneLookupSession	getSceneLookupSession(Proxy proxy) Gets the OsidSession associated with the scene lookup service.
SceneLookupSession	getSceneLookupSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the scene lookup service for the given system.
SceneNotificationSession	getSceneNotificationSession(SceneReceiver sceneReceiver, Proxy proxy) Gets the OsidSession associated with the scene notification service.
SceneNotificationSession	getSceneNotificationSessionForSystem(SceneReceiver sceneReceiver, Id systemId, Proxy proxy) Gets the OsidSession associated with the scene notification service for the given system.
SceneQuerySession	getSceneQuerySession(Proxy proxy) Gets the OsidSession associated with the scene query service.
SceneQuerySession	getSceneQuerySessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the scene query service for the given system.
SceneSearchSession	getSceneSearchSession(Proxy proxy) Gets the OsidSession associated with the scene search service.
SceneSearchSession	getSceneSearchSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the scene search service for the given system.
SceneSmartSystemSession	getSceneSmartSystemSession(Id systemId, Proxy proxy) Gets the OsidSession to manage locatin smart systems.
SceneSystemAssignmentSession	getSceneSystemAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning scenes to systems.
SceneSystemSession	getSceneSystemSession(Proxy proxy) Gets the OsidSession to lookup scene/system mappings.
SettingAdminSession	getSettingAdminSession(Proxy proxy) Gets the OsidSession associated with the setting administration service.
SettingAdminSession	getSettingAdminSessionForInput(Id inputId, Proxy proxy) Gets the OsidSession associated with the setting administration service for the given input.
SettingLookupSession	getSettingLookupSession(Proxy proxy) Gets the OsidSession associated with the setting lookup service.
SettingLookupSession	getSettingLookupSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the setting lookup service for the given system.
SettingNotificationSession	getSettingNotificationSession(SettingReceiver settingReceiver, Proxy proxy) Gets the OsidSession associated with the setting notification service.
SettingNotificationSession	getSettingNotificationSessionForSystem(SettingReceiver settingReceiver, Id systemId, Proxy proxy) Gets the OsidSession associated with the setting notification service for the given system.
SettingQuerySession	getSettingQuerySession(Proxy proxy) Gets the OsidSession associated with the setting query service.
SettingQuerySession	getSettingQuerySessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the setting query service for the given system.
SettingSearchSession	getSettingSearchSession(Proxy proxy) Gets the OsidSession associated with the setting search service.
SettingSearchSession	getSettingSearchSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the setting search service for the given system.
SettingSmartSystemSession	getSettingSmartSystemSession(Id systemId, Proxy proxy) Gets the OsidSession to manage locatin smart systems.
SettingSystemAssignmentSession	getSettingSystemAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning settings to systems.
SettingSystemSession	getSettingSystemSession(Proxy proxy) Gets the OsidSession to lookup setting/system mappings.
SystemAdminSession	getSystemAdminSession(Proxy proxy) Gets the OsidSession associated with the system administrative service.
SystemHierarchyDesignSession	getSystemHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the system hierarchy design service.
SystemHierarchySession	getSystemHierarchySession(Proxy proxy) Gets the OsidSession associated with the system hierarchy service.
SystemLookupSession	getSystemLookupSession(Proxy proxy) Gets the OsidSession associated with the system lookup service.
SystemNotificationSession	getSystemNotificationSession(SystemReceiver systemReceiver, Proxy proxy) Gets the OsidSession associated with the system notification service.
SystemQuerySession	getSystemQuerySession(Proxy proxy) Gets the OsidSession associated with the system query service.
SystemSearchSession	getSystemSearchSession(Proxy proxy) Gets the OsidSession associated with the system search service.
TriggerAdminSession	getTriggerAdminSession(Proxy proxy) Gets the OsidSession associated with the trigger administration service.
TriggerAdminSession	getTriggerAdminSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the trigger administration service for the given system.
TriggerLookupSession	getTriggerLookupSession(Proxy proxy) Gets the OsidSession associated with the trigger lookup service.
TriggerLookupSession	getTriggerLookupSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the trigger lookup service for the given system.
TriggerNotificationSession	getTriggerNotificationSession(TriggerReceiver triggerReceiver, Proxy proxy) Gets the OsidSession associated with the trigger notification service.
TriggerNotificationSession	getTriggerNotificationSessionForSystem(TriggerReceiver triggerReceiver, Id systemId, Proxy proxy) Gets the OsidSession associated with the trigger notification service for the given system.
TriggerQuerySession	getTriggerQuerySession(Proxy proxy) Gets the OsidSession associated with the trigger query service.
TriggerQuerySession	getTriggerQuerySessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the trigger query service for the given system.
TriggerSearchSession	getTriggerSearchSession(Proxy proxy) Gets the OsidSession associated with the trigger search service.
TriggerSearchSession	getTriggerSearchSessionForSystem(Id systemId, Proxy proxy) Gets the OsidSession associated with the trigger search service for the given system.
TriggerSmartSystemSession	getTriggerSmartSystemSession(Id systemId, Proxy proxy) Gets the OsidSession to manage trigger smart systems.
TriggerSystemAssignmentSession	getTriggerSystemAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning triggers to systems.
TriggerSystemSession	getTriggerSystemSession(Proxy proxy) Gets the OsidSession to lookup trigger/system mappings.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.control.ControlProfile

getActionGroupRecordTypes, getActionGroupSearchRecordTypes, getActionRecordTypes, getControllerRecordTypes, getControllerSearchRecordTypes, getDeviceRecordTypes, getDeviceReturnRecordTypes, getDeviceSearchRecordTypes, getInputRecordTypes, getInputSearchRecordTypes, getSceneRecordTypes, getSceneSearchRecordTypes, getSettingRecordTypes, getSettingSearchRecordTypes, getSystemRecordTypes, getSystemSearchRecordTypes, getTriggerRecordTypes, getTriggerSearchRecordTypes, supportsActionGroupAdmin, supportsActionGroupLookup, supportsActionGroupNotification, supportsActionGroupQuery, supportsActionGroupRecordType, supportsActionGroupSearch, supportsActionGroupSearchRecordType, supportsActionGroupSmartSystem, supportsActionGroupSystem, supportsActionGroupSystemAssignment, supportsActionRecordType, supportsControlBatch, supportsControllerAdmin, supportsControllerLookup, supportsControllerNotification, supportsControllerQuery, supportsControllerRecordType, supportsControllerSearch, supportsControllerSearchRecordType, supportsControllerSmartTrigger, supportsControllerTrigger, supportsControllerTriggerAssignment, supportsControlRules, supportsDeviceAdmin, supportsDeviceLookup, supportsDeviceNotification, supportsDeviceQuery, supportsDeviceRecordType, supportsDeviceReturn, supportsDeviceReturnRecordType, supportsDeviceSearch, supportsDeviceSearchRecordType, supportsDeviceSmartSystem, supportsDeviceSystem, supportsDeviceSystemAssignment, supportsInputAdmin, supportsInputLookup, supportsInputNotification, supportsInputQuery, supportsInputRecordType, supportsInputSearch, supportsInputSearchRecordType, supportsInputSmartSystem, supportsInputSystem, supportsInputSystemAssignment, supportsSceneAdmin, supportsSceneLookup, supportsSceneNotification, supportsSceneQuery, supportsSceneRecordType, supportsSceneSearch, supportsSceneSearchRecordType, supportsSceneSmartSystem, supportsSceneSystem, supportsSceneSystemAssignment, supportsSettingAdmin, supportsSettingLookup, supportsSettingNotification, supportsSettingQuery, supportsSettingRecordType, supportsSettingSearch, supportsSettingSearchRecordType, supportsSettingSmartSystem, supportsSettingSystem, supportsSettingSystemAssignment, supportsSystemAdmin, supportsSystemHierarchy, supportsSystemHierarchyDesign, supportsSystemLookup, supportsSystemNotification, supportsSystemQuery, supportsSystemRecordType, supportsSystemSearch, supportsSystemSearchRecordType, supportsTriggerAdmin, supportsTriggerLookup, supportsTriggerNotification, supportsTriggerQuery, supportsTriggerRecordType, supportsTriggerSearch, supportsTriggerSearchRecordType, supportsTriggerSmartSystem, supportsTriggerSystem, supportsTriggerSystemAssignment, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getDeviceLookupSession

DeviceLookupSession getDeviceLookupSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the device lookup service.

Parameters:

proxy - a proxy

Returns:

a DeviceLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceLookup() is false

Compliance:

optional - This method must be implemented if supportsDeviceLookup() is true.

getDeviceLookupSessionForSystem

DeviceLookupSession getDeviceLookupSessionForSystem(Id systemId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a DeviceLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeviceLookup() and supportsVisibleFederation() are true

getDeviceQuerySession

DeviceQuerySession getDeviceQuerySession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the device query service.

Parameters:

proxy - a proxy

Returns:

a DeviceQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceQuery() is false

Compliance:

optional - This method must be implemented if supportsDeviceQuery() is true.

getDeviceQuerySessionForSystem

DeviceQuerySession getDeviceQuerySessionForSystem(Id systemId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a DeviceQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeviceQuery() and supportsVisibleFederation() are true

getDeviceSearchSession

DeviceSearchSession getDeviceSearchSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the device search service.

Parameters:

proxy - a proxy

Returns:

a DeviceSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceSearch() is false

Compliance:

optional - This method must be implemented if supportsDeviceSearch() is true.

getDeviceSearchSessionForSystem

DeviceSearchSession getDeviceSearchSessionForSystem(Id systemId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a DeviceSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeviceSearch() and supportsVisibleFederation() are true

getDeviceAdminSession

DeviceAdminSession getDeviceAdminSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the device administration service.

Parameters:

proxy - a proxy

Returns:

a DeviceAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceAdmin() is false

Compliance:

optional - This method must be implemented if supportsDeviceAdmin() is true.

getDeviceAdminSessionForSystem

DeviceAdminSession getDeviceAdminSessionForSystem(Id systemId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

systemId - the Id of the system

proxy - a proxy

Returns:

a DeviceAdminSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeviceAdmin() and supportsVisibleFederation() are true

getDeviceNotificationSession

DeviceNotificationSession getDeviceNotificationSession(DeviceReceiver deviceReceiver,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the device notification service.

Parameters:

deviceReceiver - the notification callback

proxy - a proxy

Returns:

a DeviceNotificationSession

Throws:

NullArgumentException - deviceReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceNotification() is false

Compliance:

optional - This method must be implemented if supportsDeviceNotification() is true.

getDeviceNotificationSessionForSystem

DeviceNotificationSession getDeviceNotificationSessionForSystem(DeviceReceiver deviceReceiver,
                                                              Id systemId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

deviceReceiver - the notification callback

systemId - the Id of the System

proxy - a proxy

Returns:

a DeviceNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - deviceReceiver, systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeviceNotification() and supportsVisibleFederation() are true

getDeviceSystemSession

DeviceSystemSession getDeviceSystemSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession to lookup device/system mappings.

Parameters:

proxy - a proxy

Returns:

a DeviceSystemSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceSystem() is false

Compliance:

optional - This method must be implemented if supportsDeviceSystem() is true.

getDeviceSystemAssignmentSession

DeviceSystemAssignmentSession getDeviceSystemAssignmentSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with assigning devices to systems.

Parameters:

proxy - a proxy

Returns:

a DeviceSystemAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceSystemAssignment() is false

Compliance:

optional - This method must be implemented if supportsDeviceSystemAssignment() is true.

getDeviceSmartSystemSession

DeviceSmartSystemSession getDeviceSmartSystemSession(Id systemId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession to manage device smart systems.

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a DeviceSmartSystemSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceSmartSystem() is false

Compliance:

optional - This method must be implemented if supportsDeviceSmartSystem() is true.

getControllerLookupSession

ControllerLookupSession getControllerLookupSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the controller lookup service.

Parameters:

proxy - a proxy

Returns:

a ControllerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerLookup() is false

Compliance:

optional - This method must be implemented if supportsControllerLookup() is true.

getControllerLookupSessionForSystem

ControllerLookupSession getControllerLookupSessionForSystem(Id systemId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a ControllerLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsControllerLookup() and supportsVisibleFederation() are true

getControllerQuerySession

ControllerQuerySession getControllerQuerySession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the controller query service.

Parameters:

proxy - a proxy

Returns:

a ControllerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerQuery() is false

Compliance:

optional - This method must be implemented if supportsControllerQuery() is true.

getControllerQuerySessionForSystem

ControllerQuerySession getControllerQuerySessionForSystem(Id systemId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a ControllerQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsControllerQuery() and supportsVisibleFederation() are true

getControllerSearchSession

ControllerSearchSession getControllerSearchSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the controller search service.

Parameters:

proxy - a proxy

Returns:

a ControllerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerSearch() is false

Compliance:

optional - This method must be implemented if supportsControllerSearch() is true.

getControllerSearchSessionForSystem

ControllerSearchSession getControllerSearchSessionForSystem(Id systemId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a ControllerSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsControllerSearch() and supportsVisibleFederation() are true

getControllerAdminSession

ControllerAdminSession getControllerAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the controller administration service.

Parameters:

proxy - a proxy

Returns:

a ControllerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerAdmin() is false

Compliance:

optional - This method must be implemented if supportsControllerAdmin() is true.

getControllerAdminSessionForSystem

ControllerAdminSession getControllerAdminSessionForSystem(Id systemId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

systemId - the Id of the system

proxy - a proxy

Returns:

a ControllerAdminSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsControllerAdmin() and supportsVisibleFederation() are true

getControllerNotificationSession

ControllerNotificationSession getControllerNotificationSession(ControllerReceiver controllerReceiver,
                                                             Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the controller notification service.

Parameters:

controllerReceiver - the notification callback

proxy - a proxy

Returns:

a ControllerNotificationSession

Throws:

NullArgumentException - controllerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerNotification() is false

Compliance:

optional - This method must be implemented if supportsControllerNotification() is true.

getControllerNotificationSessionForSystem

ControllerNotificationSession getControllerNotificationSessionForSystem(ControllerReceiver controllerReceiver,
                                                                      Id systemId,
                                                                      Proxy proxy)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

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

Parameters:

controllerReceiver - the notification callback

systemId - the Id of the System

proxy - a proxy

Returns:

a ControllerNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - controllerReceiver, systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsControllerNotification() and supportsVisibleFederation() are true

getControllerSystemSession

ControllerSystemSession getControllerSystemSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession to lookup controller/system mappings.

Parameters:

proxy - a proxy

Returns:

a ControllerSystemSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerSystem() is false

Compliance:

optional - This method must be implemented if supportsControllerSystem() is true.

getControllerSystemAssignmentSession

ControllerSystemAssignmentSession getControllerSystemAssignmentSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with assigning controllers to systems.

Parameters:

proxy - a proxy

Returns:

a ControllerSystemAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerSystemAssignment() is false

Compliance:

optional - This method must be implemented if supportsControllerSystemAssignment() is true.

getControllerSmartSystemSession

ControllerSmartSystemSession getControllerSmartSystemSession(Id systemId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession to manage controller smart systems.

Parameters:

systemId - the Id of the system

proxy - a proxy

Returns:

a ControllerSmartSystemSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerSmartSystem() is false

Compliance:

optional - This method must be implemented if supportsControllerSmartSystem() is true.

getInputLookupSession

InputLookupSession getInputLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the input lookup service.

Parameters:

proxy - a proxy

Returns:

an InputLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputLookup() is false

Compliance:

optional - This method must be implemented if supportsInputLookup() is true.

getInputLookupSessionForSystem

InputLookupSession getInputLookupSessionForSystem(Id systemId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

an InputLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInputLookup() and supportsVisibleFederation() are true.

getInputQuerySession

InputQuerySession getInputQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the input query service.

Parameters:

proxy - a proxy

Returns:

an InputQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputQuery() is false

Compliance:

optional - This method must be implemented if supportsInputQuery() is true.

getInputQuerySessionForSystem

InputQuerySession getInputQuerySessionForSystem(Id systemId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

an InputQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInputQuery() and supportsVisibleFederation() are true.

getInputSearchSession

InputSearchSession getInputSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the input search service.

Parameters:

proxy - a proxy

Returns:

an InputSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputSearch() is false

Compliance:

optional - This method must be implemented if supportsInputSearch() is true.

getInputSearchSessionForSystem

InputSearchSession getInputSearchSessionForSystem(Id systemId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

an InputSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInputSearch() and supportsVisibleFederation() are true

getInputAdminSession

InputAdminSession getInputAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the input administration service.

Parameters:

proxy - a proxy

Returns:

an InputAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputAdmin() is false

Compliance:

optional - This method must be implemented if supportsInputAdmin() is true.

getInputAdminSessionForSystem

InputAdminSession getInputAdminSessionForSystem(Id systemId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

systemId - the Id of the system

proxy - a proxy

Returns:

an InputAdminSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInputAdmin() and supportsVisibleFederation() are true

getInputNotificationSession

InputNotificationSession getInputNotificationSession(InputReceiver inputReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the input notification service.

Parameters:

inputReceiver - the notification callback

proxy - a proxy

Returns:

an InputNotificationSession

Throws:

NullArgumentException - inputReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputNotification() is false

Compliance:

optional - This method must be implemented if supportsInputNotification() is true.

getInputNotificationSessionForSystem

InputNotificationSession getInputNotificationSessionForSystem(InputReceiver inputReceiver,
                                                            Id systemId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

inputReceiver - the notification callback

systemId - the Id of the System

proxy - a proxy

Returns:

an InputNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - inputReceiver, systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInputNotification() and supportsVisibleFederation() are true.

getInputSystemSession

InputSystemSession getInputSystemSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession to lookup input/system mappings.

Parameters:

proxy - a proxy

Returns:

an InputSystemSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputSystem() is false

Compliance:

optional - This method must be implemented if supportsInputSystem() is true.

getInputSystemAssignmentSession

InputSystemAssignmentSession getInputSystemAssignmentSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with assigning inputs to systems.

Parameters:

proxy - a proxy

Returns:

an InputSystemAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputSystemAssignment() is false

Compliance:

optional - This method must be implemented if supportsInputSystemAssignment() is true.

getInputSmartSystemSession

InputSmartSystemSession getInputSmartSystemSession(Id systemId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession to manage input smart systems.

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

an InputSmartSystemSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputSmartSystem() is false

Compliance:

optional - This method must be implemented if supportsInputSmartSystem() is true.

getSettingLookupSession

SettingLookupSession getSettingLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the setting lookup service.

Parameters:

proxy - a proxy

Returns:

a SettingLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingLookup() is false

Compliance:

optional - This method must be implemented if supportsSettingLookup() is true.

getSettingLookupSessionForSystem

SettingLookupSession getSettingLookupSessionForSystem(Id systemId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

systemId - the Id of the system

proxy - a proxy

Returns:

a SettingLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSettingLookup() and supportsVisibleFederation() are true.

getSettingQuerySession

SettingQuerySession getSettingQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the setting query service.

Parameters:

proxy - a proxy

Returns:

a SettingQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingQuery() is false

Compliance:

optional - This method must be implemented if supportsSettingQuery() is true.

getSettingQuerySessionForSystem

SettingQuerySession getSettingQuerySessionForSystem(Id systemId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a SettingQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSettingQuery() and supportsVisibleFederation() are true.

getSettingSearchSession

SettingSearchSession getSettingSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the setting search service.

Parameters:

proxy - a proxy

Returns:

a SettingSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingSearch() is false

Compliance:

optional - This method must be implemented if supportsSettingSearch() is true.

getSettingSearchSessionForSystem

SettingSearchSession getSettingSearchSessionForSystem(Id systemId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a SettingSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSettingSearch() and supportsVisibleFederation() are true.

getSettingAdminSession

SettingAdminSession getSettingAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the setting administration service.

Parameters:

proxy - a proxy

Returns:

a SettingAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingAdmin() is false

Compliance:

optional - This method must be implemented if supportsSettingAdmin() is true.

getSettingAdminSessionForInput

SettingAdminSession getSettingAdminSessionForInput(Id inputId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

inputId - the Id of the Input

proxy - a proxy

Returns:

a SettingAdminSession

Throws:

NotFoundException - no input found by the given Id

NullArgumentException - inputId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSettingAdmin() and supportsVisibleFederation() are true.

getSettingNotificationSession

SettingNotificationSession getSettingNotificationSession(SettingReceiver settingReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the setting notification service.

Parameters:

settingReceiver - the notification callback

proxy - a proxy

Returns:

a SettingNotificationSession

Throws:

NullArgumentException - settingReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingNotification() is false

Compliance:

optional - This method must be implemented if supportsSettingNotification() is true.

getSettingNotificationSessionForSystem

SettingNotificationSession getSettingNotificationSessionForSystem(SettingReceiver settingReceiver,
                                                                Id systemId,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

settingReceiver - the notification callback

systemId - the Id of the System

proxy - a proxy

Returns:

a SettingNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - settingReceiver, systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSettingNotification() and supportsVisibleFederation() are true.

getSettingSystemSession

SettingSystemSession getSettingSystemSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession to lookup setting/system mappings.

Parameters:

proxy - a proxy

Returns:

a SettingSystemSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingSystem() is false

Compliance:

optional - This method must be implemented if supportsSettingSystem() is true.

getSettingSystemAssignmentSession

SettingSystemAssignmentSession getSettingSystemAssignmentSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with assigning settings to systems.

Parameters:

proxy - a proxy

Returns:

a SettingSystemAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingSystemAssignment() is false

Compliance:

optional - This method must be implemented if supportsSettingSystemAssignment() is true.

getSettingSmartSystemSession

SettingSmartSystemSession getSettingSmartSystemSession(Id systemId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession to manage locatin smart systems.

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a SettingSmartSystemSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingSmartSystem() is false

Compliance:

optional - This method must be implemented if supportsSettingSmartSystem() is true.

getSceneLookupSession

SceneLookupSession getSceneLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the scene lookup service.

Parameters:

proxy - a proxy

Returns:

a SceneLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneLookup() is false

Compliance:

optional - This method must be implemented if supportsSceneLookup() is true.

getSceneLookupSessionForSystem

SceneLookupSession getSceneLookupSessionForSystem(Id systemId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

systemId - the Id of the system

proxy - a proxy

Returns:

a SceneLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSceneLookup() and supportsVisibleFederation() are true.

getSceneQuerySession

SceneQuerySession getSceneQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the scene query service.

Parameters:

proxy - a proxy

Returns:

a SceneQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneQuery() is false

Compliance:

optional - This method must be implemented if supportsSceneQuery() is true.

getSceneQuerySessionForSystem

SceneQuerySession getSceneQuerySessionForSystem(Id systemId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a SceneQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSceneQuery() and supportsVisibleFederation() are true.

getSceneSearchSession

SceneSearchSession getSceneSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the scene search service.

Parameters:

proxy - a proxy

Returns:

a SceneSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneSearch() is false

Compliance:

optional - This method must be implemented if supportsSceneSearch() is true.

getSceneSearchSessionForSystem

SceneSearchSession getSceneSearchSessionForSystem(Id systemId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a SceneSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSceneSearch() and supportsVisibleFederation() are true.

getSceneAdminSession

SceneAdminSession getSceneAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the scene administration service.

Parameters:

proxy - a proxy

Returns:

a SceneAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneAdmin() is false

Compliance:

optional - This method must be implemented if supportsSceneAdmin() is true.

getSceneAdminSessionForSystem

SceneAdminSession getSceneAdminSessionForSystem(Id systemId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a SceneAdminSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSceneAdmin() and supportsVisibleFederation() are true.

getSceneNotificationSession

SceneNotificationSession getSceneNotificationSession(SceneReceiver sceneReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the scene notification service.

Parameters:

sceneReceiver - the notification callback

proxy - a proxy

Returns:

a SceneNotificationSession

Throws:

NullArgumentException - sceneReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneNotification() is false

Compliance:

optional - This method must be implemented if supportsSceneNotification() is true.

getSceneNotificationSessionForSystem

SceneNotificationSession getSceneNotificationSessionForSystem(SceneReceiver sceneReceiver,
                                                            Id systemId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

sceneReceiver - the notification callback

systemId - the Id of the System

proxy - a proxy

Returns:

a SceneNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - sceneReceiver, systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSceneNotification() and supportsVisibleFederation() are true.

getSceneSystemSession

SceneSystemSession getSceneSystemSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession to lookup scene/system mappings.

Parameters:

proxy - a proxy

Returns:

a SceneSystemSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneSystem() is false

Compliance:

optional - This method must be implemented if supportsSceneSystem() is true.

getSceneSystemAssignmentSession

SceneSystemAssignmentSession getSceneSystemAssignmentSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with assigning scenes to systems.

Parameters:

proxy - a proxy

Returns:

a SceneSystemAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneSystemAssignment() is false

Compliance:

optional - This method must be implemented if supportsSceneSystemAssignment() is true.

getSceneSmartSystemSession

SceneSmartSystemSession getSceneSmartSystemSession(Id systemId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession to manage locatin smart systems.

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a SceneSmartSystemSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneSmartSystem() is false

Compliance:

optional - This method must be implemented if supportsSceneSmartSystem() is true.

getTriggerLookupSession

TriggerLookupSession getTriggerLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the trigger lookup service.

Parameters:

proxy - a proxy

Returns:

a TriggerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerLookup() is false

Compliance:

optional - This method must be implemented if supportsTriggerLookup() is true.

getTriggerLookupSessionForSystem

TriggerLookupSession getTriggerLookupSessionForSystem(Id systemId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a TriggerLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTriggerLookup() and supportsVisibleFederation() are true

getTriggerQuerySession

TriggerQuerySession getTriggerQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the trigger query service.

Parameters:

proxy - a proxy

Returns:

a TriggerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerQuery() is false

Compliance:

optional - This method must be implemented if supportsTriggerQuery() is true.

getTriggerQuerySessionForSystem

TriggerQuerySession getTriggerQuerySessionForSystem(Id systemId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a TriggerQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTriggerQuery() and supportsVisibleFederation() are true

getTriggerSearchSession

TriggerSearchSession getTriggerSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the trigger search service.

Parameters:

proxy - a proxy

Returns:

a TriggerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerSearch() is false

Compliance:

optional - This method must be implemented if supportsTriggerSearch() is true.

getTriggerSearchSessionForSystem

TriggerSearchSession getTriggerSearchSessionForSystem(Id systemId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a TriggerSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTriggerSearch() and supportsVisibleFederation() are true

getTriggerAdminSession

TriggerAdminSession getTriggerAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the trigger administration service.

Parameters:

proxy - a proxy

Returns:

a TriggerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerAdmin() is false

Compliance:

optional - This method must be implemented if supportsTriggerAdmin() is true.

getTriggerAdminSessionForSystem

TriggerAdminSession getTriggerAdminSessionForSystem(Id systemId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a TriggerAdminSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTriggerAdmin() and supportsVisibleFederation() are true

getTriggerNotificationSession

TriggerNotificationSession getTriggerNotificationSession(TriggerReceiver triggerReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the trigger notification service.

Parameters:

triggerReceiver - the notification callback

proxy - a proxy

Returns:

a TriggerNotificationSession

Throws:

NullArgumentException - triggerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerNotification() is false

Compliance:

optional - This method must be implemented if supportsTriggerNotification() is true.

getTriggerNotificationSessionForSystem

TriggerNotificationSession getTriggerNotificationSessionForSystem(TriggerReceiver triggerReceiver,
                                                                Id systemId,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

triggerReceiver - the notification callback

systemId - the Id of the System

proxy - a proxy

Returns:

a TriggerNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - triggerReceiver, systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTriggerNotification() and supportsVisibleFederation() are true

getTriggerSystemSession

TriggerSystemSession getTriggerSystemSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession to lookup trigger/system mappings.

Parameters:

proxy - a proxy

Returns:

a TriggerSystemSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerSystem() is false

Compliance:

optional - This method must be implemented if supportsTriggerSystem() is true.

getTriggerSystemAssignmentSession

TriggerSystemAssignmentSession getTriggerSystemAssignmentSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with assigning triggers to systems.

Parameters:

proxy - a proxy

Returns:

a TriggerSystemAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerSystemAssignment() is false

Compliance:

optional - This method must be implemented if supportsTriggerSystemAssignment() is true.

getTriggerSmartSystemSession

TriggerSmartSystemSession getTriggerSmartSystemSession(Id systemId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession to manage trigger smart systems.

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a TriggerSmartSystemSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerSmartSystem() is false

Compliance:

optional - This method must be implemented if supportsTriggerSmartSystem() is true.

getActionGroupLookupSession

ActionGroupLookupSession getActionGroupLookupSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the action group lookup service.

Parameters:

proxy - a proxy

Returns:

an ActionGroupLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupLookup() is false

Compliance:

optional - This method must be implemented if supportsActionGroupLookup() is true.

getActionGroupLookupSessionForSystem

ActionGroupLookupSession getActionGroupLookupSessionForSystem(Id systemId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

an ActionGroupLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActionGroupLookup() and supportsVisibleFederation() are true

getActionGroupQuerySession

ActionGroupQuerySession getActionGroupQuerySession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the action group query service.

Parameters:

proxy - a proxy

Returns:

an ActionGroupQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupQuery() is false

Compliance:

optional - This method must be implemented if supportsActionGroupQuery() is true.

getActionGroupQuerySessionForSystem

ActionGroupQuerySession getActionGroupQuerySessionForSystem(Id systemId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

an ActionGroupQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActionGroupQuery() and supportsVisibleFederation() are true

getActionGroupSearchSession

ActionGroupSearchSession getActionGroupSearchSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the action group search service.

Parameters:

proxy - a proxy

Returns:

an ActionGroupSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupSearch() is false

Compliance:

optional - This method must be implemented if supportsActionGroupSearch() is true.

getActionGroupSearchSessionForSystem

ActionGroupSearchSession getActionGroupSearchSessionForSystem(Id systemId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

an ActionGroupSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActionGroupSearch() and supportsVisibleFederation() are true

getActionGroupAdminSession

ActionGroupAdminSession getActionGroupAdminSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the action group administration service.

Parameters:

proxy - a proxy

Returns:

an ActionGroupAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupAdmin() is false

Compliance:

optional - This method must be implemented if supportsActionGroupAdmin() is true.

getActionGroupAdminSessionForSystem

ActionGroupAdminSession getActionGroupAdminSessionForSystem(Id systemId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

an ActionGroupAdminSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActionGroupAdmin() and supportsVisibleFederation() are true

getActionGroupNotificationSession

ActionGroupNotificationSession getActionGroupNotificationSession(ActionGroupReceiver actionGroupReceiver,
                                                               Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the action group notification service.

Parameters:

actionGroupReceiver - the notification callback

proxy - a proxy

Returns:

an ActionGroupNotificationSession

Throws:

NullArgumentException - actionGroupReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupNotification() is false

Compliance:

optional - This method must be implemented if supportsActionGroupNotification() is true.

getActionGroupNotificationSessionForSystem

ActionGroupNotificationSession getActionGroupNotificationSessionForSystem(ActionGroupReceiver actionGroupReceiver,
                                                                        Id systemId,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

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

Parameters:

actionGroupReceiver - the notification callback

systemId - the Id of the System

proxy - a proxy

Returns:

an ActionGroupNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - actionGroupReceiver, systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActionGroupNotification() and supportsVisibleFederation() are true

getActionGroupSystemSession

ActionGroupSystemSession getActionGroupSystemSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession to lookup action group/system mappings.

Parameters:

proxy - a proxy

Returns:

an ActionGroupSystemSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupSystem() is false

Compliance:

optional - This method must be implemented if supportsActionGroupSystem() is true.

getActionGroupSystemAssignmentSession

ActionGroupSystemAssignmentSession getActionGroupSystemAssignmentSession(Proxy proxy)
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning action groups to systems.

Parameters:

proxy - a proxy

Returns:

an ActionGroupSystemAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupSystemAssignment() is false

Compliance:

optional - This method must be implemented if supportsActionGroupSystemAssignment() is true.

getActionGroupSmartSystemSession

ActionGroupSmartSystemSession getActionGroupSmartSystemSession(Id systemId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession to manage action group smart systems.

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

an ActionGroupSmartSystemSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupSmartSystem() is false

Compliance:

optional - This method must be implemented if supportsActionGroupSmartSystem() is true.

getSystemLookupSession

SystemLookupSession getSystemLookupSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the system lookup service.

Parameters:

proxy - a proxy

Returns:

a SystemLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemLookup() is false

Compliance:

optional - This method must be implemented if supportsSystemLookup() is true.

getSystemQuerySession

SystemQuerySession getSystemQuerySession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the system query service.

Parameters:

proxy - a proxy

Returns:

a SystemQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemQuery() is false

Compliance:

optional - This method must be implemented if supportsSystemQuery() is true.

getSystemSearchSession

SystemSearchSession getSystemSearchSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the system search service.

Parameters:

proxy - a proxy

Returns:

a SystemSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemSearch() is false

Compliance:

optional - This method must be implemented if supportsSystemSearch() is true.

getSystemAdminSession

SystemAdminSession getSystemAdminSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the system administrative service.

Parameters:

proxy - a proxy

Returns:

a SystemAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemAdmin() is false

Compliance:

optional - This method must be implemented if supportsSystemAdmin() is true.

getSystemNotificationSession

SystemNotificationSession getSystemNotificationSession(SystemReceiver systemReceiver,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the system notification service.

Parameters:

systemReceiver - the notification callback

proxy - a proxy

Returns:

a SystemNotificationSession

Throws:

NullArgumentException - systemReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemNotification() is false

Compliance:

optional - This method must be implemented if supportsSystemNotification() is true.

getSystemHierarchySession

SystemHierarchySession getSystemHierarchySession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the system hierarchy service.

Parameters:

proxy - a proxy

Returns:

a SystemHierarchySession for systems

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemHierarchy() is false

Compliance:

optional - This method must be implemented if supportsSystemHierarchy() is true.

getSystemHierarchyDesignSession

SystemHierarchyDesignSession getSystemHierarchyDesignSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the system hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a HierarchyDesignSession for systems

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsSystemHierarchyDesign() is true.

getControlBatchProxyManager

ControlBatchProxyManager getControlBatchProxyManager()
                                                     throws OperationFailedException

Gets the ControlBatchProxyManager.

Returns:

a ControlBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsControlBatch() is false

Compliance:

optional - This method must be implemented if supportsControlBatch() is true.

getControlRulesProxyManager

ControlRulesProxyManager getControlRulesProxyManager()
                                                     throws OperationFailedException

Gets the ControlRulesProxyManager.

Returns:

a ControlRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsControlRules() is false

Compliance:

optional - This method must be implemented if supportsControlRules() is true.