Interface ControlManager

All Superinterfaces:

AutoCloseable, Closeable, ControlProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface ControlManager
extends OsidManager, ControlProfile

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

• DeviceLookupSession : a session to retrieve devices
• DeviceQuerySession : a session to query for devicess
• DeviceSearchSession : a session to search for devices
• DeviceAdminSession : a session to create and delete devices
• DeviceNotificationSession : a session to receive notifications pertaining to device changes
• DeviceSystemSession : a session to look up device system mappings
• DeviceSystemAssignmentSession : a session to manage device to system mappings
• DeviceSmartSystemSession : a session to manage dynamic systems of devices

• ControllerLookupSession : a session to retrieve controllers
• ControllerQuerySession : a session to query for controllers
• ControllerSearchSession : a session to search for controllers
• ControllerAdminSession : a session to create and delete controllers
• ControllerNotificationSession : a session to receive notifications pertaining to controller changes
• ControllerSystemSession : a session to look up controller system mappings
• ControllerSystemAssignmentSession : a session to manage controller to system mappings
• ControllerSmartSystemSession : a session to manage dynamic systems of controllers

• InputLookupSession : a session to retrieve inputs
• InputQuerySession : a session to query for inputs
• InputSearchSession : a session to search for inputs
• InputAdminSession : a session to create and delete inputs
• InputNotificationSession : a session to receive notifications pertaining to input changes
• InputSystemSession : a session to look up input system mappings
• InputSystemAssignmentSession : a session to manage inputs to system mappings
• InputSmartSystemSession : a session to manage dynamic systems of inputs

• SettingLookupSession : a session to retrieve settings
• SettingQuerySession : a session to query for settings
• SettingSearchSession : a session to search for settings
• SettingAdminSession : a session to create and delete settings
• SettingNotificationSession : a session to receive notifications pertaining to setting changes
• SettingSystemsSession : a session to look up setting systems mappings
• SettingSystemAssignmentSession : a session to manage setting to system mappings
• SettingSmartSystemSession : a session to manage dynamic systems of settings

• SceneLookupSession : a session to retrieve scenes
• SceneQuerySession : a session to query for scenes
• SceneSearchSession : a session to search for scenes
• SceneAdminSession : a session to create and delete scenes
• SceneNotificationSession : a session to receive notifications pertaining to scene changes
• SceneSystemsSession : a session to look up scene systems mappings
• SceneSystemAssignmentSession : a session to manage scene to system mappings
• SceneSmartSystemSession : a session to manage dynamic systems of scenes

• TriggerLookupSession : a session to retrieve triggers
• TriggerQuerySession : a session to query for triggers
• TriggerSearchSession : a session to search for triggers
• TriggerAdminSession : a session to create and delete triggers
• TriggerNotificationSession : a session to receive notifications pertaining to trigger changes
• TriggerSystemSession : a session to look up mappings of triggers to systems
• TriggerSystemAssignmentSession : a session to manage trigger to system mappings
• TriggerSmartSystemSession : a session to manage dynamic systems of triggers

• ActionGroupLookupSession : a session to retrieve action groups
• ActionGroupQuerySession : a session to query for action groups
• ActionGroupSearchSession : a session to search for action groups
• ActionGroupAdminSession : a session to create and delete action groups
• ActionGroupNotificationSession : a session to receive notifications pertaining to action group changes
• ActionGroupSystemSession : a session to look up mappings of action groups to systems
• ActionGroupSystemAssignmentSession : a session to manage action group to system mappings
• ActionGroupSmartSystemSession : a session to manage dynamic systems of action groups

• SystemLookupSession : a session to retrieve systems
• SystemQuerySession : a session to search for systems
• SystemSearchSession : a session to search for systems
• SystemAdminSession : a session to create and delete systems
• SystemNotificationSession : a session to receive notifications pertaining to system changes
• SystemHierarchySession : a session to traverse a hierarchy of system
• SystemHierarchyDesignSession : a session to manage a system hierarchy

Method Summary

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

Methods inherited from interface Closeable

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getActionGroupRecordTypes()	Gets the supported ActionGroup record types.
TypeList	getActionGroupSearchRecordTypes()	Gets the supported ActionGroup search record types.
TypeList	getActionRecordTypes()	Gets the supported Action record types.
TypeList	getControllerRecordTypes()	Gets the supported Controller record types.
TypeList	getControllerSearchRecordTypes()	Gets the supported Controller search record types.
TypeList	getDeviceRecordTypes()	Gets the supported Device record types.
TypeList	getDeviceReturnRecordTypes()	Gets the supported DeviceReturn record types.
TypeList	getDeviceSearchRecordTypes()	Gets the supported Device search types.
TypeList	getInputRecordTypes()	Gets the supported Input record types.
TypeList	getInputSearchRecordTypes()	Gets the supported Input search types.
TypeList	getSceneRecordTypes()	Gets the supported Scene record types.
TypeList	getSceneSearchRecordTypes()	Gets the supported Scene search types.
TypeList	getSettingRecordTypes()	Gets the supported Setting record types.
TypeList	getSettingSearchRecordTypes()	Gets the supported Setting search types.
TypeList	getSystemRecordTypes()	Gets the supported System record types.
TypeList	getSystemSearchRecordTypes()	Gets the supported System search record types.
TypeList	getTriggerRecordTypes()	Gets the supported Trigger record types.
TypeList	getTriggerSearchRecordTypes()	Gets the supported Trigger search record types.
boolean	supportsActionGroupAdmin()	Tests if action group administrative service is supported.
boolean	supportsActionGroupLookup()	Tests if looking up action groups is supported.
boolean	supportsActionGroupNotification()	Tests if an action group notification service is supported.
boolean	supportsActionGroupQuery()	Tests if querying action groups is supported.
boolean	supportsActionGroupRecordType(Type actionGroupRecordType)	Tests if the given ActionGroup record type is supported.
boolean	supportsActionGroupSearch()	Tests if searching action groups is supported.
boolean	supportsActionGroupSearchRecordType(Type actionGroupSearchRecordType)	Tests if the given ActionGroup search record type is supported.
boolean	supportsActionGroupSmartSystem()	Tests if an action group smart system lookup service is supported.
boolean	supportsActionGroupSystem()	Tests if an action group system lookup service is supported.
boolean	supportsActionGroupSystemAssignment()	Tests if an action group system service is supported.
boolean	supportsActionRecordType(Type actionRecordType)	Tests if the given Action record type is supported.
boolean	supportsControlBatch()	Tests for the availability of a control batch service.
boolean	supportsControllerAdmin()	Tests if controller administrative service is supported.
boolean	supportsControllerLookup()	Tests if looking up controllers is supported.
boolean	supportsControllerNotification()	Tests if a controller notification service is supported.
boolean	supportsControllerQuery()	Tests if querying controllers is supported.
boolean	supportsControllerRecordType(Type controllerRecordType)	Tests if the given Controller record type is supported.
boolean	supportsControllerSearch()	Tests if searching controllers is supported.
boolean	supportsControllerSearchRecordType(Type controllerSearchRecordType)	Tests if the given Controller search record type is supported.
boolean	supportsControllerSmartTrigger()	Tests if a controller smart trigger lookup service is supported.
boolean	supportsControllerTrigger()	Tests if a controller trigger lookup service is supported.
boolean	supportsControllerTriggerAssignment()	Tests if a controller trigger service is supported.
boolean	supportsControlRules()	Tests for the availability of a control rules service.
boolean	supportsDeviceAdmin()	Tests if a device administrative service is supported.
boolean	supportsDeviceLookup()	Tests if looking up devices is supported.
boolean	supportsDeviceNotification()	Tests if a device notification service is supported.
boolean	supportsDeviceQuery()	Tests if querying devices is supported.
boolean	supportsDeviceRecordType(Type deviceRecordType)	Tests if the given Device record type is supported.
boolean	supportsDeviceReturn()	Tests if returning devices is supported.
boolean	supportsDeviceReturnRecordType(Type deviceReturnRecordType)	Tests if the given DeviceReturn record type is supported.
boolean	supportsDeviceSearch()	Tests if searching devices is supported.
boolean	supportsDeviceSearchRecordType(Type deviceSearchRecordType)	Tests if the given Device search type is supported.
boolean	supportsDeviceSmartSystem()	Tests if a device smart system service is supported.
boolean	supportsDeviceSystem()	Tests if a device system lookup service is supported.
boolean	supportsDeviceSystemAssignment()	Tests if a device system assignment service is supported.
boolean	supportsInputAdmin()	Tests if an input administrative service is supported.
boolean	supportsInputLookup()	Tests if looking up inputs is supported.
boolean	supportsInputNotification()	Tests if an input notification service is supported.
boolean	supportsInputQuery()	Tests if querying inputs is supported.
boolean	supportsInputRecordType(Type inputRecordType)	Tests if the given Input record type is supported.
boolean	supportsInputSearch()	Tests if searching inputs is supported.
boolean	supportsInputSearchRecordType(Type inputSearchRecordType)	Tests if the given Input search type is supported.
boolean	supportsInputSmartSystem()	Tests if an input smart system service is supported.
boolean	supportsInputSystem()	Tests if an input system lookup service is supported.
boolean	supportsInputSystemAssignment()	Tests if an input system assignment service is supported.
boolean	supportsSceneAdmin()	Tests if scene administrative service is supported.
boolean	supportsSceneLookup()	Tests if looking up scenes is supported.
boolean	supportsSceneNotification()	Tests if a scene notification service is supported.
boolean	supportsSceneQuery()	Tests if querying scenes is supported.
boolean	supportsSceneRecordType(Type sceneRecordType)	Tests if the given Scene record type is supported.
boolean	supportsSceneSearch()	Tests if searching scenes is supported.
boolean	supportsSceneSearchRecordType(Type sceneSearchRecordType)	Tests if the given Scene search type is supported.
boolean	supportsSceneSmartSystem()	Tests if a scene smart system service is supported.
boolean	supportsSceneSystem()	Tests if a scene system lookup service is supported.
boolean	supportsSceneSystemAssignment()	Tests if a scene system assignment service is supported.
boolean	supportsSettingAdmin()	Tests if setting administrative service is supported.
boolean	supportsSettingLookup()	Tests if looking up settings is supported.
boolean	supportsSettingNotification()	Tests if a setting notification service is supported.
boolean	supportsSettingQuery()	Tests if querying settings is supported.
boolean	supportsSettingRecordType(Type settingRecordType)	Tests if the given Setting record type is supported.
boolean	supportsSettingSearch()	Tests if searching settings is supported.
boolean	supportsSettingSearchRecordType(Type settingSearchRecordType)	Tests if the given Setting search type is supported.
boolean	supportsSettingSmartSystem()	Tests if a setting smart system service is supported.
boolean	supportsSettingSystem()	Tests if a setting system lookup service is supported.
boolean	supportsSettingSystemAssignment()	Tests if a setting system assignment service is supported.
boolean	supportsSystemAdmin()	Tests if system administrative service is supported.
boolean	supportsSystemHierarchy()	Tests for the availability of a system hierarchy traversal service.
boolean	supportsSystemHierarchyDesign()	Tests for the availability of a system hierarchy design service.
boolean	supportsSystemLookup()	Tests if looking up systems is supported.
boolean	supportsSystemNotification()	Tests if a system notification service is supported.
boolean	supportsSystemQuery()	Tests if querying systems is supported.
boolean	supportsSystemRecordType(Type systemRecordType)	Tests if the given System record type is supported.
boolean	supportsSystemSearch()	Tests if searching systems is supported.
boolean	supportsSystemSearchRecordType(Type systemSearchRecordType)	Tests if the given System search record type is supported.
boolean	supportsTriggerAdmin()	Tests if trigger administrative service is supported.
boolean	supportsTriggerLookup()	Tests if looking up triggers is supported.
boolean	supportsTriggerNotification()	Tests if a trigger notification service is supported.
boolean	supportsTriggerQuery()	Tests if querying triggers is supported.
boolean	supportsTriggerRecordType(Type triggerRecordType)	Tests if the given Trigger record type is supported.
boolean	supportsTriggerSearch()	Tests if searching triggers is supported.
boolean	supportsTriggerSearchRecordType(Type triggerSearchRecordType)	Tests if the given Trigger search record type is supported.
boolean	supportsTriggerSmartSystem()	Tests if a trigger smart system lookup service is supported.
boolean	supportsTriggerSystem()	Tests if a trigger system lookup service is supported.
boolean	supportsTriggerSystemAssignment()	Tests if a trigger system service is supported.
boolean	supportsVisibleFederation()	Tests if any trigger federation is exposed.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getDeviceLookupSession

DeviceLookupSession getDeviceLookupSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the device lookup service.

Returns:

a DeviceLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsDeviceLookup()} is {@code true} .

getDeviceLookupSessionForSystem

DeviceLookupSession getDeviceLookupSessionForSystem(Id systemId)
                                             throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a DeviceLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDeviceLookup()} and {@code supportsVisibleFederation()} are {@code true}

getDeviceQuerySession

DeviceQuerySession getDeviceQuerySession()
                                  throws OperationFailedException

Gets the OsidSession associated with the device query service.

Returns:

a DeviceQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDeviceQuery()} is {@code true} .

getDeviceQuerySessionForSystem

DeviceQuerySession getDeviceQuerySessionForSystem(Id systemId)
                                           throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a DeviceQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDeviceQuery()} and {@code supportsVisibleFederation()} are {@code true}

getDeviceSearchSession

DeviceSearchSession getDeviceSearchSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the device search service.

Returns:

a DeviceSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsDeviceSearch()} is {@code true} .

getDeviceSearchSessionForSystem

DeviceSearchSession getDeviceSearchSessionForSystem(Id systemId)
                                             throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a DeviceSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDeviceSearch()} and {@code supportsVisibleFederation()} are {@code true}

getDeviceAdminSession

DeviceAdminSession getDeviceAdminSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the device administration service.

Returns:

a DeviceAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsDeviceAdmin()} is {@code true} .

getDeviceAdminSessionForSystem

DeviceAdminSession getDeviceAdminSessionForSystem(Id systemId)
                                           throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a DeviceAdminSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDeviceAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getDeviceNotificationSession

DeviceNotificationSession getDeviceNotificationSession(DeviceReceiver deviceReceiver)
                                                throws OperationFailedException

Gets the OsidSession associated with the device notification service.

Parameters:

deviceReceiver - the notification callback

Returns:

a DeviceNotificationSession

Throws:

NullArgumentException - deviceReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsDeviceNotification()} is {@code true} .

getDeviceNotificationSessionForSystem

DeviceNotificationSession getDeviceNotificationSessionForSystem(DeviceReceiver deviceReceiver,
 Id systemId)
                                                         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

Returns:

a DeviceNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - deviceReceiver or systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDeviceNotification()} and {@code supportsVisibleFederation()} are {@code true}

getDeviceSystemSession

DeviceSystemSession getDeviceSystemSession()
                                    throws OperationFailedException

Gets the OsidSession to lookup device/system mappings.

Returns:

a DeviceSystemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsDeviceSystem()} is {@code true} .

getDeviceSystemAssignmentSession

DeviceSystemAssignmentSession getDeviceSystemAssignmentSession()
                                                        throws OperationFailedException

Gets the OsidSession associated with assigning devices to systems.

Returns:

a DeviceSystemAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceSystemAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsDeviceSystemAssignment()} is {@code true} .

getDeviceSmartSystemSession

DeviceSmartSystemSession getDeviceSmartSystemSession(Id systemId)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage device smart systems.

Parameters:

systemId - the Id of the System

Returns:

a DeviceSmartSystemSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceSmartSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsDeviceSmartSystem()} is {@code true} .

getControllerLookupSession

ControllerLookupSession getControllerLookupSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the controller lookup service.

Returns:

a ControllerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerLookup()} is {@code true} .

getControllerLookupSessionForSystem

ControllerLookupSession getControllerLookupSessionForSystem(Id systemId)
                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a ControllerLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerLookup()} and {@code supportsVisibleFederation()} are {@code true}

getControllerQuerySession

ControllerQuerySession getControllerQuerySession()
                                          throws OperationFailedException

Gets the OsidSession associated with the controller query service.

Returns:

a ControllerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerQuery()} is {@code true} .

getControllerQuerySessionForSystem

ControllerQuerySession getControllerQuerySessionForSystem(Id systemId)
                                                   throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a ControllerQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerQuery()} and {@code supportsVisibleFederation()} are {@code true}

getControllerSearchSession

ControllerSearchSession getControllerSearchSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the controller search service.

Returns:

a ControllerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerSearch()} is {@code true} .

getControllerSearchSessionForSystem

ControllerSearchSession getControllerSearchSessionForSystem(Id systemId)
                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a ControllerSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerSearch()} and {@code supportsVisibleFederation()} are {@code true}

getControllerAdminSession

ControllerAdminSession getControllerAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the controller administration service.

Returns:

a ControllerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerAdmin()} is {@code true} .

getControllerAdminSessionForSystem

ControllerAdminSession getControllerAdminSessionForSystem(Id systemId)
                                                   throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a ControllerAdminSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getControllerNotificationSession

ControllerNotificationSession getControllerNotificationSession(ControllerReceiver controllerReceiver)
                                                        throws OperationFailedException

Gets the OsidSession associated with the controller notification service.

Parameters:

controllerReceiver - the notification callback

Returns:

a ControllerNotificationSession

Throws:

NullArgumentException - controllerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerNotification()} is {@code true} .

getControllerNotificationSessionForSystem

ControllerNotificationSession getControllerNotificationSessionForSystem(ControllerReceiver controllerReceiver,
 Id systemId)
                                                                 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

Returns:

a ControllerNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - controllerReceiver or systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerNotification()} and {@code supportsVisibleFederation()} are {@code true}

getControllerSystemSession

ControllerSystemSession getControllerSystemSession()
                                            throws OperationFailedException

Gets the OsidSession to lookup controller/system mappings.

Returns:

a ControllerSystemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerSystem()} is {@code true} .

getControllerSystemAssignmentSession

ControllerSystemAssignmentSession getControllerSystemAssignmentSession()
                                                                throws OperationFailedException

Gets the OsidSession associated with assigning controllers to systems.

Returns:

a ControllerSystemAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerSystemAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerSystemAssignment()} is {@code true} .

getControllerSmartSystemSession

ControllerSmartSystemSession getControllerSmartSystemSession(Id systemId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage controller smart systems.

Parameters:

systemId - the Id of the system

Returns:

a ControllerSmartSystemSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerSmartSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerSmartSystem()} is {@code true} .

getInputLookupSession

InputLookupSession getInputLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the input lookup service.

Returns:

an InputLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsInputLookup()} is {@code true} .

getInputLookupSessionForSystem

InputLookupSession getInputLookupSessionForSystem(Id systemId)
                                           throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an InputLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsInputLookup()} and {@code supportsVisibleFederation()} are {@code true}

getInputQuerySession

InputQuerySession getInputQuerySession()
                                throws OperationFailedException

Gets the OsidSession associated with the input query service.

Returns:

an InputQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsInputQuery()} is {@code true} .

getInputQuerySessionForSystem

InputQuerySession getInputQuerySessionForSystem(Id systemId)
                                         throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an InputQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsInputQuery()} and {@code supportsVisibleFederation()} are {@code true}

getInputSearchSession

InputSearchSession getInputSearchSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the input search service.

Returns:

an InputSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsInputSearch()} is {@code true} .

getInputSearchSessionForSystem

InputSearchSession getInputSearchSessionForSystem(Id systemId)
                                           throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an InputSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsInputSearch()} and {@code supportsVisibleFederation()} are {@code true}

getInputAdminSession

InputAdminSession getInputAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the input administration service.

Returns:

an InputAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsInputAdmin()} is {@code true} .

getInputAdminSessionForSystem

InputAdminSession getInputAdminSessionForSystem(Id systemId)
                                         throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an InputAdminSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsInputAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getInputNotificationSession

InputNotificationSession getInputNotificationSession(InputReceiver inputReceiver)
                                              throws OperationFailedException

Gets the OsidSession associated with the input notification service.

Parameters:

inputReceiver - the notification callback

Returns:

an InputNotificationSession

Throws:

NullArgumentException - inputReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsInputNotification()} is {@code true} .

getInputNotificationSessionForSystem

InputNotificationSession getInputNotificationSessionForSystem(InputReceiver inputReceiver,
 Id systemId)
                                                       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

Returns:

an InputNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - inputReceiver or systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsInputNotification()} and {@code supportsVisibleFederation()} are {@code true}

getInputSystemSession

InputSystemSession getInputSystemSession()
                                  throws OperationFailedException

Gets the OsidSession to lookup input/system mappings.

Returns:

an InputSystemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsInputSystem()} is {@code true} .

getInputSystemAssignmentSession

InputSystemAssignmentSession getInputSystemAssignmentSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with assigning inputs to systems.

Returns:

an InputSystemAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputSystemAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsInputSystemAssignment()} is {@code true} .

getInputSmartSystemSession

InputSmartSystemSession getInputSmartSystemSession(Id systemId)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage input smart systems.

Parameters:

systemId - the Id of the System

Returns:

an InputSmartSystemSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputSmartSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsInputSmartSystem()} is {@code true} .

getSettingLookupSession

SettingLookupSession getSettingLookupSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the setting lookup service.

Returns:

a SettingLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingLookup()} is {@code true} .

getSettingLookupSessionForSystem

SettingLookupSession getSettingLookupSessionForSystem(Id systemId)
                                               throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the system

Returns:

a SettingLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingLookup()} and {@code supportsVisibleFederation()} are {@code true}

getSettingQuerySession

SettingQuerySession getSettingQuerySession()
                                    throws OperationFailedException

Gets the OsidSession associated with the setting query service.

Returns:

a SettingQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingQuery()} is {@code true} .

getSettingQuerySessionForSystem

SettingQuerySession getSettingQuerySessionForSystem(Id systemId)
                                             throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a SettingQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingQuery()} and {@code supportsVisibleFederation()} are {@code true}

getSettingSearchSession

SettingSearchSession getSettingSearchSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the setting search service.

Returns:

a SettingSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingSearch()} is {@code true} .

getSettingSearchSessionForSystem

SettingSearchSession getSettingSearchSessionForSystem(Id systemId)
                                               throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a SettingSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingSearch()} and {@code supportsVisibleFederation()} are {@code true}

getSettingAdminSession

SettingAdminSession getSettingAdminSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the setting administration service.

Returns:

a SettingAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingAdmin()} is {@code true} .

getSettingAdminSessionForInput

SettingAdminSession getSettingAdminSessionForInput(Id systemId)
                                            throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the Dostributor

Returns:

a SettingAdminSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getSettingNotificationSession

SettingNotificationSession getSettingNotificationSession(SettingReceiver settingReceiver)
                                                  throws OperationFailedException

Gets the OsidSession associated with the setting notification service.

Parameters:

settingReceiver - the notification callback

Returns:

a SettingNotificationSession

Throws:

NullArgumentException - settingReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingNotification()} is {@code true} .

getSettingNotificationSessionForSystem

SettingNotificationSession getSettingNotificationSessionForSystem(SettingReceiver settingReceiver,
 Id systemId)
                                                           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

Returns:

a SettingNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - settingReceiver or systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingNotification()} and {@code supportsVisibleFederation()} are {@code true}

getSettingSystemSession

SettingSystemSession getSettingSystemSession()
                                      throws OperationFailedException

Gets the OsidSession to lookup setting/system mappings.

Returns:

a SettingSystemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingSystem()} is {@code true} .

getSettingSystemAssignmentSession

SettingSystemAssignmentSession getSettingSystemAssignmentSession()
                                                          throws OperationFailedException

Gets the OsidSession associated with assigning settings to systems.

Returns:

a SettingSystemAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingSystemAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingSystemAssignment()} is {@code true} .

getSettingSmartSystemSession

SettingSmartSystemSession getSettingSmartSystemSession(Id systemId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage locatin smart systems.

Parameters:

systemId - the Id of the System

Returns:

a SettingSmartSystemSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingSmartSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingSmartSystem()} is {@code true} .

getSceneLookupSession

SceneLookupSession getSceneLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the scene lookup service.

Returns:

a SceneLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneLookup()} is {@code true} .

getSceneLookupSessionForSystem

SceneLookupSession getSceneLookupSessionForSystem(Id systemId)
                                           throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the system

Returns:

a SceneLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneLookup()} and {@code supportsVisibleFederation()} are {@code true}

getSceneQuerySession

SceneQuerySession getSceneQuerySession()
                                throws OperationFailedException

Gets the OsidSession associated with the scene query service.

Returns:

a SceneQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneQuery()} is {@code true} .

getSceneQuerySessionForSystem

SceneQuerySession getSceneQuerySessionForSystem(Id systemId)
                                         throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a SceneQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneQuery()} and {@code supportsVisibleFederation()} are {@code true}

getSceneSearchSession

SceneSearchSession getSceneSearchSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the scene search service.

Returns:

a SceneSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneSearch()} is {@code true} .

getSceneSearchSessionForSystem

SceneSearchSession getSceneSearchSessionForSystem(Id systemId)
                                           throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a SceneSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneSearch()} and {@code supportsVisibleFederation()} are {@code true}

getSceneAdminSession

SceneAdminSession getSceneAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the scene administration service.

Returns:

a SceneAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneAdmin()} is {@code true} .

getSceneAdminSessionForSystem

SceneAdminSession getSceneAdminSessionForSystem(Id systemId)
                                         throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the Dostributor

Returns:

a SceneAdminSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getSceneNotificationSession

SceneNotificationSession getSceneNotificationSession(SceneReceiver sceneReceiver)
                                              throws OperationFailedException

Gets the OsidSession associated with the scene notification service.

Parameters:

sceneReceiver - the notification callback

Returns:

a SceneNotificationSession

Throws:

NullArgumentException - sceneReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneNotification()} is {@code true} .

getSceneNotificationSessionForSystem

SceneNotificationSession getSceneNotificationSessionForSystem(SceneReceiver sceneReceiver,
 Id systemId)
                                                       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

Returns:

a SceneNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - sceneReceiver or systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneNotification()} and {@code supportsVisibleFederation()} are {@code true}

getSceneSystemSession

SceneSystemSession getSceneSystemSession()
                                  throws OperationFailedException

Gets the OsidSession to lookup scene/system mappings.

Returns:

a SceneSystemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneSystem()} is {@code true} .

getSceneSystemAssignmentSession

SceneSystemAssignmentSession getSceneSystemAssignmentSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with assigning scenes to systems.

Returns:

a SceneSystemAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneSystemAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneSystemAssignment()} is {@code true} .

getSceneSmartSystemSession

SceneSmartSystemSession getSceneSmartSystemSession(Id systemId)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage locatin smart systems.

Parameters:

systemId - the Id of the System

Returns:

a SceneSmartSystemSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneSmartSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneSmartSystem()} is {@code true} .

getTriggerLookupSession

TriggerLookupSession getTriggerLookupSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the trigger lookup service.

Returns:

a TriggerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsTriggerLookup()} is {@code true} .

getTriggerLookupSessionForSystem

TriggerLookupSession getTriggerLookupSessionForSystem(Id systemId)
                                               throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a TriggerLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTriggerLookup()} and {@code supportsVisibleFederation()} are {@code true}

getTriggerQuerySession

TriggerQuerySession getTriggerQuerySession()
                                    throws OperationFailedException

Gets the OsidSession associated with the trigger query service.

Returns:

a TriggerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsTriggerQuery()} is {@code true} .

getTriggerQuerySessionForSystem

TriggerQuerySession getTriggerQuerySessionForSystem(Id systemId)
                                             throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a TriggerQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTriggerQuery()} and {@code supportsVisibleFederation()} are {@code true}

getTriggerSearchSession

TriggerSearchSession getTriggerSearchSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the trigger search service.

Returns:

a TriggerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsTriggerSearch()} is {@code true} .

getTriggerSearchSessionForSystem

TriggerSearchSession getTriggerSearchSessionForSystem(Id systemId)
                                               throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a TriggerSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTriggerSearch()} and {@code supportsVisibleFederation()} are {@code true}

getTriggerAdminSession

TriggerAdminSession getTriggerAdminSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the trigger administration service.

Returns:

a TriggerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsTriggerAdmin()} is {@code true} .

getTriggerAdminSessionForSystem

TriggerAdminSession getTriggerAdminSessionForSystem(Id systemId)
                                             throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a TriggerAdminSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTriggerAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getTriggerNotificationSession

TriggerNotificationSession getTriggerNotificationSession(TriggerReceiver triggerReceiver)
                                                  throws OperationFailedException

Gets the OsidSession associated with the trigger notification service.

Parameters:

triggerReceiver - the notification callback

Returns:

a TriggerNotificationSession

Throws:

NullArgumentException - triggerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsTriggerNotification()} is {@code true} .

getTriggerNotificationSessionForSystem

TriggerNotificationSession getTriggerNotificationSessionForSystem(TriggerReceiver triggerReceiver,
 Id systemId)
                                                           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

Returns:

a TriggerNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - triggerReceiver or systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsTriggerNotification()} and {@code supportsVisibleFederation()} are {@code true}

getTriggerSystemSession

TriggerSystemSession getTriggerSystemSession()
                                      throws OperationFailedException

Gets the OsidSession to lookup trigger/system mappings.

Returns:

a TriggerSystemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsTriggerSystem()} is {@code true} .

getTriggerSystemAssignmentSession

TriggerSystemAssignmentSession getTriggerSystemAssignmentSession()
                                                          throws OperationFailedException

Gets the OsidSession associated with assigning triggers to systems.

Returns:

a TriggerSystemAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerSystemAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsTriggerSystemAssignment()} is {@code true} .

getTriggerSmartSystemSession

TriggerSmartSystemSession getTriggerSmartSystemSession(Id systemId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage trigger smart systems.

Parameters:

systemId - the Id of the System

Returns:

a TriggerSmartSystemSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerSmartSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsTriggerSmartSystem()} is {@code true} .

getActionGroupLookupSession

ActionGroupLookupSession getActionGroupLookupSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the action group lookup service.

Returns:

an ActionGroupLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupLookup()} is {@code true} .

getActionGroupLookupSessionForSystem

ActionGroupLookupSession getActionGroupLookupSessionForSystem(Id systemId)
                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an ActionGroupLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupLookup()} and {@code supportsVisibleFederation()} are {@code true}

getActionGroupQuerySession

ActionGroupQuerySession getActionGroupQuerySession()
                                            throws OperationFailedException

Gets the OsidSession associated with the action group query service.

Returns:

an ActionGroupQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupQuery()} is {@code true} .

getActionGroupQuerySessionForSystem

ActionGroupQuerySession getActionGroupQuerySessionForSystem(Id systemId)
                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an ActionGroupQuerySession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupQuery()} and {@code supportsVisibleFederation()} are {@code true}

getActionGroupSearchSession

ActionGroupSearchSession getActionGroupSearchSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the action group search service.

Returns:

an ActionGroupSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupSearch()} is {@code true} .

getActionGroupSearchSessionForSystem

ActionGroupSearchSession getActionGroupSearchSessionForSystem(Id systemId)
                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an ActionGroupSearchSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupSearch()} and {@code supportsVisibleFederation()} are {@code true}

getActionGroupAdminSession

ActionGroupAdminSession getActionGroupAdminSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the action group administration service.

Returns:

an ActionGroupAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupAdmin()} is {@code true} .

getActionGroupAdminSessionForSystem

ActionGroupAdminSession getActionGroupAdminSessionForSystem(Id systemId)
                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an ActionGroupAdminSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getActionGroupNotificationSession

ActionGroupNotificationSession getActionGroupNotificationSession(ActionGroupReceiver actionGroupReceiver)
                                                          throws OperationFailedException

Gets the OsidSession associated with the action group notification service.

Parameters:

actionGroupReceiver - the notification callback

Returns:

an ActionGroupNotificationSession

Throws:

NullArgumentException - actionGroupReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupNotification()} is {@code true} .

getActionGroupNotificationSessionForSystem

ActionGroupNotificationSession getActionGroupNotificationSessionForSystem(ActionGroupReceiver actionGroupReceiver,
 Id systemId)
                                                                   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

Returns:

an ActionGroupNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - actionGroupReceiver or systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupNotification()} and {@code supportsVisibleFederation()} are {@code true}

getActionGroupSystemSession

ActionGroupSystemSession getActionGroupSystemSession()
                                              throws OperationFailedException

Gets the OsidSession to lookup action group/system mappings.

Returns:

an ActionGroupSystemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupSystem()} is {@code true} .

getActionGroupSystemAssignmentSession

ActionGroupSystemAssignmentSession getActionGroupSystemAssignmentSession()
                                                                  throws OperationFailedException

Gets the OsidSession associated with assigning action groups to systems.

Returns:

an ActionGroupSystemAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupSystemAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupSystemAssignment()} is {@code true} .

getActionGroupSmartSystemSession

ActionGroupSmartSystemSession getActionGroupSmartSystemSession(Id systemId)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage action group smart systems.

Parameters:

systemId - the Id of the System

Returns:

an ActionGroupSmartSystemSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupSmartSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupSmartSystem()} is {@code true} .

getSystemLookupSession

SystemLookupSession getSystemLookupSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the system lookup service.

Returns:

a SystemLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSystemLookup()} is {@code true} .

getSystemQuerySession

SystemQuerySession getSystemQuerySession()
                                  throws OperationFailedException

Gets the OsidSession associated with the system query service.

Returns:

a SystemQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSystemQuery()} is {@code true} .

getSystemSearchSession

SystemSearchSession getSystemSearchSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the system search service.

Returns:

a SystemSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsSystemSearch()} is {@code true} .

getSystemAdminSession

SystemAdminSession getSystemAdminSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the system administrative service.

Returns:

a SystemAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsSystemAdmin()} is {@code true} .

getSystemNotificationSession

SystemNotificationSession getSystemNotificationSession(SystemReceiver systemReceiver)
                                                throws OperationFailedException

Gets the OsidSession associated with the system notification service.

Parameters:

systemReceiver - the notification callback

Returns:

a SystemNotificationSession

Throws:

NullArgumentException - systemReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsSystemNotification()} is {@code true} .

getSystemHierarchySession

SystemHierarchySession getSystemHierarchySession()
                                          throws OperationFailedException

Gets the OsidSession associated with the system hierarchy service.

Returns:

a SystemHierarchySession for systems

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsSystemHierarchy()} is {@code true} .

getSystemHierarchyDesignSession

SystemHierarchyDesignSession getSystemHierarchyDesignSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with the system hierarchy design service.

Returns:

a HierarchyDesignSession for systems

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsSystemHierarchyDesign()} is {@code true} .

getControlBatchManager

ControlBatchManager getControlBatchManager()
                                    throws OperationFailedException

Gets the ControlBatchManager .

Returns:

a ControlBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsControlBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsControlBatch()} is {@code true} .

getControlRulesManager

ControlRulesManager getControlRulesManager()
                                    throws OperationFailedException

Gets the ControlRulesManager .

Returns:

a ControlRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsControlRules() is false

Compliance:

optional - This method must be implemented if {@code supportsControlRules()} is {@code true} .