public interface ControlProxyManager extends OsidProxyManager, ControlProfile
The control proxy manager provides access to control sessions and
provides interoperability tests for various aspects of this service.
Methods in this manager pass a Proxy
for passing
information from server environments. The sessions included in this
manager are:
DeviceLookupSession:
a session to retrieve devices
DeviceQuerySession:
a session to query for
devicess DeviceSearchSession:
a session to search for
devices DeviceAdminSession:
a session to create and delete
devices DeviceNotificationSession:
a session to receive
notifications pertaining to device changes DeviceSystemSession:
a session to look up device
system mappings DeviceSystemAssignmentSession:
a session to manage
device to system mappings DeviceSmartSystemSession:
a session to manage
dynamic systems of devices ControllerLookupSession:
a session to retrieve
controllers ControllerQuerySession:
a session to query for
controllers ControllerSearchSession:
a session to search for
controllers ControllerAdminSession:
a session to create and
delete controllers ControllerNotificationSession:
a session to
receive notifications pertaining to controller changes ControllerSystemSession:
a session to look up
controller system mappings ControllerSystemAssignmentSession:
a session to
manage controller to system mappings ControllerSmartSystemSession:
a session to manage
dynamic systems of controllers InputLookupSession:
a session to retrieve inputs
InputQuerySession:
a session to query for inputs
InputSearchSession:
a session to search for inputs
InputAdminSession:
a session to create and delete
inputs InputNotificationSession:
a session to receive
notifications pertaining to input changes InputSystemSession:
a session to look up input
system mappings InputSystemAssignmentSession:
a session to manage
inputs to system mappings InputSmartSystemSession:
a session to manage
dynamic systems of inputs SettingLookupSession:
a session to retrieve
settings SettingQuerySession:
a session to query for
settings SettingSearchSession:
a session to search for
settings SettingAdminSession:
a session to create and
delete settings SettingNotificationSession:
a session to receive
notifications pertaining to setting changes SettingSystemsSession:
a session to look up
setting systems mappings SettingSystemAssignmentSession:
a session to
manage setting to system mappings SettingSmartSystemSession:
a session to manage
dynamic systems of settings SceneLookupSession:
a session to retrieve scenes
SceneQuerySession:
a session to query for scenes
SceneSearchSession:
a session to search for scenes
SceneAdminSession:
a session to create and delete
scenes SceneNotificationSession:
a session to receive
notifications pertaining to scene changes SceneSystemsSession:
a session to look up scene
systems mappings SceneSystemAssignmentSession:
a session to manage
scene to system mappings SceneSmartSystemSession:
a session to manage
dynamic systems of scenes TriggerLookupSession:
a session to retrieve
triggers TriggerQuerySession:
a session to query for
triggers TriggerSearchSession:
a session to search for
triggers TriggerAdminSession:
a session to create and
delete triggers TriggerNotificationSession:
a session to receive
notifications pertaining to trigger changes TriggerSystemSession:
a session to look up
mappings of triggers to systems TriggerSystemAssignmentSession:
a session to
manage trigger to system mappings TriggerSmartSystemSession:
a session to manage
dynamic systems of triggers ActionGroupLookupSession:
a session to retrieve
action groups ActionGroupQuerySession:
a session to query for
action groups ActionGroupSearchSession:
a session to search for
action groups ActionGroupAdminSession:
a session to create and
delete action groups ActionGroupNotificationSession:
a session to
receive notifications pertaining to action group changes ActionGroupSystemSession:
a session to look up
mappings of action groups to systems ActionGroupSystemAssignmentSession:
a session to
manage action group to system mappings ActionGroupSmartSystemSession:
a session to manage
dynamic systems of action groups SystemLookupSession:
a session to retrieve systems
SystemQuerySession:
a session to search for
systems SystemSearchSession:
a session to search for
systems SystemAdminSession:
a session to create and delete
systems SystemNotificationSession:
a session to receive
notifications pertaining to system changes SystemHierarchySession:
a session to traverse a
hierarchy of system SystemHierarchyDesignSession:
a session to manage
a system hierarchy Modifier and Type | Method and Description |
---|---|
ActionGroupAdminSession |
getActionGroupAdminSession(Proxy proxy)
Gets the
OsidSession associated with the action group
administration service. |
ActionGroupAdminSession |
getActionGroupAdminSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the action group
administration service for the given system. |
ActionGroupLookupSession |
getActionGroupLookupSession(Proxy proxy)
Gets the
OsidSession associated with the action group
lookup service. |
ActionGroupLookupSession |
getActionGroupLookupSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the action group
lookup service for the given system. |
ActionGroupNotificationSession |
getActionGroupNotificationSession(ActionGroupReceiver actionGroupReceiver,
Proxy proxy)
Gets the
OsidSession associated with the action group
notification service. |
ActionGroupNotificationSession |
getActionGroupNotificationSessionForSystem(ActionGroupReceiver actionGroupReceiver,
Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the action group
notification service for the given system. |
ActionGroupQuerySession |
getActionGroupQuerySession(Proxy proxy)
Gets the
OsidSession associated with the action group
query service. |
ActionGroupQuerySession |
getActionGroupQuerySessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the action group
query service for the given system. |
ActionGroupSearchSession |
getActionGroupSearchSession(Proxy proxy)
Gets the
OsidSession associated with the action group
search service. |
ActionGroupSearchSession |
getActionGroupSearchSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the action group
search service for the given system. |
ActionGroupSmartSystemSession |
getActionGroupSmartSystemSession(Id systemId,
Proxy proxy)
Gets the
OsidSession to manage action group smart
systems. |
ActionGroupSystemAssignmentSession |
getActionGroupSystemAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning action
groups to systems. |
ActionGroupSystemSession |
getActionGroupSystemSession(Proxy proxy)
Gets the
OsidSession to lookup action group/system
mappings. |
ControlBatchProxyManager |
getControlBatchProxyManager()
Gets the
ControlBatchProxyManager. |
ControllerAdminSession |
getControllerAdminSession(Proxy proxy)
Gets the
OsidSession associated with the controller
administration service. |
ControllerAdminSession |
getControllerAdminSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the controller
administration service for the given system. |
ControllerLookupSession |
getControllerLookupSession(Proxy proxy)
Gets the
OsidSession associated with the controller
lookup service. |
ControllerLookupSession |
getControllerLookupSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the controller
lookup service for the given system. |
ControllerNotificationSession |
getControllerNotificationSession(ControllerReceiver controllerReceiver,
Proxy proxy)
Gets the
OsidSession associated with the controller
notification service. |
ControllerNotificationSession |
getControllerNotificationSessionForSystem(ControllerReceiver controllerReceiver,
Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the controller
notification service for the given system. |
ControllerQuerySession |
getControllerQuerySession(Proxy proxy)
Gets the
OsidSession associated with the controller
query service. |
ControllerQuerySession |
getControllerQuerySessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the controller
query service for the given system. |
ControllerSearchSession |
getControllerSearchSession(Proxy proxy)
Gets the
OsidSession associated with the controller
search service. |
ControllerSearchSession |
getControllerSearchSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the controller
search service for the given system. |
ControllerSmartSystemSession |
getControllerSmartSystemSession(Id systemId,
Proxy proxy)
Gets the
OsidSession to manage controller smart
systems. |
ControllerSystemAssignmentSession |
getControllerSystemAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning
controllers to systems. |
ControllerSystemSession |
getControllerSystemSession(Proxy proxy)
Gets the
OsidSession to lookup controller/system
mappings. |
ControlRulesProxyManager |
getControlRulesProxyManager()
Gets the
ControlRulesProxyManager. |
DeviceAdminSession |
getDeviceAdminSession(Proxy proxy)
Gets the
OsidSession associated with the device
administration service. |
DeviceAdminSession |
getDeviceAdminSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the device
administration service for the given system. |
DeviceLookupSession |
getDeviceLookupSession(Proxy proxy)
Gets the
OsidSession associated with the device lookup
service. |
DeviceLookupSession |
getDeviceLookupSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the device lookup
service for the given system. |
DeviceNotificationSession |
getDeviceNotificationSession(DeviceReceiver deviceReceiver,
Proxy proxy)
Gets the
OsidSession associated with the device
notification service. |
DeviceNotificationSession |
getDeviceNotificationSessionForSystem(DeviceReceiver deviceReceiver,
Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the device
notification service for the given system. |
DeviceQuerySession |
getDeviceQuerySession(Proxy proxy)
Gets the
OsidSession associated with the device query
service. |
DeviceQuerySession |
getDeviceQuerySessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the device query
service for the given system. |
DeviceSearchSession |
getDeviceSearchSession(Proxy proxy)
Gets the
OsidSession associated with the device search
service. |
DeviceSearchSession |
getDeviceSearchSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the device search
service for the given system. |
DeviceSmartSystemSession |
getDeviceSmartSystemSession(Id systemId,
Proxy proxy)
Gets the
OsidSession to manage device smart systems. |
DeviceSystemAssignmentSession |
getDeviceSystemAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning devices
to systems. |
DeviceSystemSession |
getDeviceSystemSession(Proxy proxy)
Gets the
OsidSession to lookup device/system mappings. |
InputAdminSession |
getInputAdminSession(Proxy proxy)
Gets the
OsidSession associated with the input
administration service. |
InputAdminSession |
getInputAdminSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the input
administration service for the given system. |
InputLookupSession |
getInputLookupSession(Proxy proxy)
Gets the
OsidSession associated with the input lookup
service. |
InputLookupSession |
getInputLookupSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the input lookup
service for the given system. |
InputNotificationSession |
getInputNotificationSession(InputReceiver inputReceiver,
Proxy proxy)
Gets the
OsidSession associated with the input
notification service. |
InputNotificationSession |
getInputNotificationSessionForSystem(InputReceiver inputReceiver,
Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the input
notification service for the given system. |
InputQuerySession |
getInputQuerySession(Proxy proxy)
Gets the
OsidSession associated with the input query
service. |
InputQuerySession |
getInputQuerySessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the input query
service for the given system. |
InputSearchSession |
getInputSearchSession(Proxy proxy)
Gets the
OsidSession associated with the input search
service. |
InputSearchSession |
getInputSearchSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the input search
service for the given system. |
InputSmartSystemSession |
getInputSmartSystemSession(Id systemId,
Proxy proxy)
Gets the
OsidSession to manage input smart systems. |
InputSystemAssignmentSession |
getInputSystemAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning inputs
to systems. |
InputSystemSession |
getInputSystemSession(Proxy proxy)
Gets the
OsidSession to lookup input/system mappings. |
SceneAdminSession |
getSceneAdminSession(Proxy proxy)
Gets the
OsidSession associated with the scene
administration service. |
SceneAdminSession |
getSceneAdminSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the scene
administration service for the given system. |
SceneLookupSession |
getSceneLookupSession(Proxy proxy)
Gets the
OsidSession associated with the scene lookup
service. |
SceneLookupSession |
getSceneLookupSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the scene lookup
service for the given system. |
SceneNotificationSession |
getSceneNotificationSession(SceneReceiver sceneReceiver,
Proxy proxy)
Gets the
OsidSession associated with the scene
notification service. |
SceneNotificationSession |
getSceneNotificationSessionForSystem(SceneReceiver sceneReceiver,
Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the scene
notification service for the given system. |
SceneQuerySession |
getSceneQuerySession(Proxy proxy)
Gets the
OsidSession associated with the scene query
service. |
SceneQuerySession |
getSceneQuerySessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the scene query
service for the given system. |
SceneSearchSession |
getSceneSearchSession(Proxy proxy)
Gets the
OsidSession associated with the scene search
service. |
SceneSearchSession |
getSceneSearchSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the scene search
service for the given system. |
SceneSmartSystemSession |
getSceneSmartSystemSession(Id systemId,
Proxy proxy)
Gets the
OsidSession to manage locatin smart systems. |
SceneSystemAssignmentSession |
getSceneSystemAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning scenes
to systems. |
SceneSystemSession |
getSceneSystemSession(Proxy proxy)
Gets the
OsidSession to lookup scene/system mappings. |
SettingAdminSession |
getSettingAdminSession(Proxy proxy)
Gets the
OsidSession associated with the setting
administration service. |
SettingAdminSession |
getSettingAdminSessionForInput(Id inputId,
Proxy proxy)
Gets the
OsidSession associated with the setting
administration service for the given input. |
SettingLookupSession |
getSettingLookupSession(Proxy proxy)
Gets the
OsidSession associated with the setting lookup
service. |
SettingLookupSession |
getSettingLookupSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the setting lookup
service for the given system. |
SettingNotificationSession |
getSettingNotificationSession(SettingReceiver settingReceiver,
Proxy proxy)
Gets the
OsidSession associated with the setting
notification service. |
SettingNotificationSession |
getSettingNotificationSessionForSystem(SettingReceiver settingReceiver,
Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the setting
notification service for the given system. |
SettingQuerySession |
getSettingQuerySession(Proxy proxy)
Gets the
OsidSession associated with the setting query
service. |
SettingQuerySession |
getSettingQuerySessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the setting query
service for the given system. |
SettingSearchSession |
getSettingSearchSession(Proxy proxy)
Gets the
OsidSession associated with the setting search
service. |
SettingSearchSession |
getSettingSearchSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the setting search
service for the given system. |
SettingSmartSystemSession |
getSettingSmartSystemSession(Id systemId,
Proxy proxy)
Gets the
OsidSession to manage locatin smart systems. |
SettingSystemAssignmentSession |
getSettingSystemAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning settings
to systems. |
SettingSystemSession |
getSettingSystemSession(Proxy proxy)
Gets the
OsidSession to lookup setting/system mappings. |
SystemAdminSession |
getSystemAdminSession(Proxy proxy)
Gets the
OsidSession associated with the system
administrative service. |
SystemHierarchyDesignSession |
getSystemHierarchyDesignSession(Proxy proxy)
Gets the
OsidSession associated with the system
hierarchy design service. |
SystemHierarchySession |
getSystemHierarchySession(Proxy proxy)
Gets the
OsidSession associated with the system
hierarchy service. |
SystemLookupSession |
getSystemLookupSession(Proxy proxy)
Gets the
OsidSession associated with the system lookup
service. |
SystemNotificationSession |
getSystemNotificationSession(SystemReceiver systemReceiver,
Proxy proxy)
Gets the
OsidSession associated with the system
notification service. |
SystemQuerySession |
getSystemQuerySession(Proxy proxy)
Gets the
OsidSession associated with the system query
service. |
SystemSearchSession |
getSystemSearchSession(Proxy proxy)
Gets the
OsidSession associated with the system search
service. |
TriggerAdminSession |
getTriggerAdminSession(Proxy proxy)
Gets the
OsidSession associated with the trigger
administration service. |
TriggerAdminSession |
getTriggerAdminSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the trigger
administration service for the given system. |
TriggerLookupSession |
getTriggerLookupSession(Proxy proxy)
Gets the
OsidSession associated with the trigger lookup
service. |
TriggerLookupSession |
getTriggerLookupSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the trigger lookup
service for the given system. |
TriggerNotificationSession |
getTriggerNotificationSession(TriggerReceiver triggerReceiver,
Proxy proxy)
Gets the
OsidSession associated with the trigger
notification service. |
TriggerNotificationSession |
getTriggerNotificationSessionForSystem(TriggerReceiver triggerReceiver,
Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the trigger
notification service for the given system. |
TriggerQuerySession |
getTriggerQuerySession(Proxy proxy)
Gets the
OsidSession associated with the trigger query
service. |
TriggerQuerySession |
getTriggerQuerySessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the trigger query
service for the given system. |
TriggerSearchSession |
getTriggerSearchSession(Proxy proxy)
Gets the
OsidSession associated with the trigger search
service. |
TriggerSearchSession |
getTriggerSearchSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the trigger search
service for the given system. |
TriggerSmartSystemSession |
getTriggerSmartSystemSession(Id systemId,
Proxy proxy)
Gets the
OsidSession to manage trigger smart systems. |
TriggerSystemAssignmentSession |
getTriggerSystemAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning triggers
to systems. |
TriggerSystemSession |
getTriggerSystemSession(Proxy proxy)
Gets the
OsidSession to lookup trigger/system mappings. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
DeviceLookupSession getDeviceLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the device lookup
service.proxy
- a proxy DeviceLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceLookup()
is false
optional
- This method must be implemented if
supportsDeviceLookup()
is true.
DeviceLookupSession getDeviceLookupSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the device lookup
service for the given system.systemId
- the Id
of the System
proxy
- a proxy DeviceLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsDeviceLookup()
and
supportsVisibleFederation()
are true
DeviceQuerySession getDeviceQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the device query
service.proxy
- a proxy DeviceQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceQuery()
is false
optional
- This method must be implemented if
supportsDeviceQuery()
is true.
DeviceQuerySession getDeviceQuerySessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the device query
service for the given system.systemId
- the Id
of the System
proxy
- a proxy DeviceQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsDeviceQuery()
and
supportsVisibleFederation()
are true
DeviceSearchSession getDeviceSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the device search
service.proxy
- a proxy DeviceSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceSearch()
is false
optional
- This method must be implemented if
supportsDeviceSearch()
is true.
DeviceSearchSession getDeviceSearchSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the device search
service for the given system.systemId
- the Id
of the System
proxy
- a proxy DeviceSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsDeviceSearch()
and
supportsVisibleFederation()
are true
DeviceAdminSession getDeviceAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the device
administration service.proxy
- a proxy DeviceAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceAdmin()
is false
optional
- This method must be implemented if
supportsDeviceAdmin()
is true.
DeviceAdminSession getDeviceAdminSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the device
administration service for the given system.systemId
- the Id
of the systemproxy
- a proxy DeviceAdminSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsDeviceAdmin()
and
supportsVisibleFederation()
are true
DeviceNotificationSession getDeviceNotificationSession(DeviceReceiver deviceReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the device
notification service.deviceReceiver
- the notification callbackproxy
- a proxy DeviceNotificationSession
NullArgumentException
- deviceReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDeviceNotification()
is false
optional
- This method must be implemented if
supportsDeviceNotification()
is true.
DeviceNotificationSession getDeviceNotificationSessionForSystem(DeviceReceiver deviceReceiver, Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the device
notification service for the given system.deviceReceiver
- the notification callbacksystemId
- the Id
of the System
proxy
- a proxy DeviceNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- deviceReceiver, systemId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDeviceNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDeviceNotification()
and
supportsVisibleFederation()
are true
DeviceSystemSession getDeviceSystemSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup device/system mappings.proxy
- a proxy DeviceSystemSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceSystem()
is false
optional
- This method must be implemented if
supportsDeviceSystem()
is true.
DeviceSystemAssignmentSession getDeviceSystemAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning devices
to systems.proxy
- a proxy DeviceSystemAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDeviceSystemAssignment()
is false
optional
- This method must be implemented if
supportsDeviceSystemAssignment()
is true.
DeviceSmartSystemSession getDeviceSmartSystemSession(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage device smart systems.systemId
- the Id
of the System
proxy
- a proxy DeviceSmartSystemSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDeviceSmartSystem()
is false
optional
- This method must be implemented if
supportsDeviceSmartSystem()
is true.
ControllerLookupSession getControllerLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the controller
lookup service.proxy
- a proxy ControllerLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerLookup()
is false
optional
- This method must be implemented if
supportsControllerLookup()
is true.
ControllerLookupSession getControllerLookupSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the controller
lookup service for the given system.systemId
- the Id
of the System
proxy
- a proxy ControllerLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsControllerLookup()
and
supportsVisibleFederation()
are true
ControllerQuerySession getControllerQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the controller
query service.proxy
- a proxy ControllerQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerQuery()
is false
optional
- This method must be implemented if
supportsControllerQuery()
is true.
ControllerQuerySession getControllerQuerySessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the controller
query service for the given system.systemId
- the Id
of the System
proxy
- a proxy ControllerQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsControllerQuery()
and
supportsVisibleFederation()
are true
ControllerSearchSession getControllerSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the controller
search service.proxy
- a proxy ControllerSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerSearch()
is false
optional
- This method must be implemented if
supportsControllerSearch()
is true.
ControllerSearchSession getControllerSearchSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the controller
search service for the given system.systemId
- the Id
of the System
proxy
- a proxy ControllerSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsControllerSearch()
and
supportsVisibleFederation()
are true
ControllerAdminSession getControllerAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the controller
administration service.proxy
- a proxy ControllerAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerAdmin()
is false
optional
- This method must be implemented if
supportsControllerAdmin()
is true.
ControllerAdminSession getControllerAdminSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the controller
administration service for the given system.systemId
- the Id
of the systemproxy
- a proxy ControllerAdminSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsControllerAdmin()
and
supportsVisibleFederation()
are true
ControllerNotificationSession getControllerNotificationSession(ControllerReceiver controllerReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the controller
notification service.controllerReceiver
- the notification callbackproxy
- a proxy ControllerNotificationSession
NullArgumentException
- controllerReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerNotification()
is false
optional
- This method must be implemented if
supportsControllerNotification()
is true.
ControllerNotificationSession getControllerNotificationSessionForSystem(ControllerReceiver controllerReceiver, Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the controller
notification service for the given system.controllerReceiver
- the notification callbacksystemId
- the Id
of the System
proxy
- a proxy ControllerNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- controllerReceiver,
systemId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsControllerNotification()
and
supportsVisibleFederation()
are true
ControllerSystemSession getControllerSystemSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup controller/system
mappings.proxy
- a proxy ControllerSystemSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerSystem()
is false
optional
- This method must be implemented if
supportsControllerSystem()
is true.
ControllerSystemAssignmentSession getControllerSystemAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning
controllers to systems.proxy
- a proxy ControllerSystemAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerSystemAssignment()
is false
optional
- This method must be implemented if
supportsControllerSystemAssignment()
is
true.
ControllerSmartSystemSession getControllerSmartSystemSession(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage controller smart
systems.systemId
- the Id
of the systemproxy
- a proxy ControllerSmartSystemSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerSmartSystem()
is false
optional
- This method must be implemented if
supportsControllerSmartSystem()
is true.
InputLookupSession getInputLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the input lookup
service.proxy
- a proxy InputLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputLookup()
is false
optional
- This method must be implemented if
supportsInputLookup()
is true.
InputLookupSession getInputLookupSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the input lookup
service for the given system.systemId
- the Id
of the System
proxy
- a proxy InputLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsInputLookup()
and
supportsVisibleFederation()
are true.
InputQuerySession getInputQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the input query
service.proxy
- a proxy InputQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputQuery()
is false
optional
- This method must be implemented if
supportsInputQuery()
is true.
InputQuerySession getInputQuerySessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the input query
service for the given system.systemId
- the Id
of the System
proxy
- a proxy InputQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsInputQuery()
and
supportsVisibleFederation()
are true.
InputSearchSession getInputSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the input search
service.proxy
- a proxy InputSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputSearch()
is false
optional
- This method must be implemented if
supportsInputSearch()
is true.
InputSearchSession getInputSearchSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the input search
service for the given system.systemId
- the Id
of the System
proxy
- a proxy InputSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsInputSearch()
and
supportsVisibleFederation()
are true
InputAdminSession getInputAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the input
administration service.proxy
- a proxy InputAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputAdmin()
is false
optional
- This method must be implemented if
supportsInputAdmin()
is true.
InputAdminSession getInputAdminSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the input
administration service for the given system.systemId
- the Id
of the systemproxy
- a proxy InputAdminSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsInputAdmin()
and
supportsVisibleFederation()
are true
InputNotificationSession getInputNotificationSession(InputReceiver inputReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the input
notification service.inputReceiver
- the notification callbackproxy
- a proxy InputNotificationSession
NullArgumentException
- inputReceiver
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInputNotification()
is false
optional
- This method must be implemented if
supportsInputNotification()
is true.
InputNotificationSession getInputNotificationSessionForSystem(InputReceiver inputReceiver, Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the input
notification service for the given system.inputReceiver
- the notification callbacksystemId
- the Id
of the System
proxy
- a proxy InputNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- inputReceiver, systemId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInputNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsInputNotification()
and
supportsVisibleFederation()
are true.
InputSystemSession getInputSystemSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup input/system mappings.proxy
- a proxy InputSystemSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputSystem()
is false
optional
- This method must be implemented if
supportsInputSystem()
is true.
InputSystemAssignmentSession getInputSystemAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning inputs
to systems.proxy
- a proxy InputSystemAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInputSystemAssignment()
is false
optional
- This method must be implemented if
supportsInputSystemAssignment()
is true.
InputSmartSystemSession getInputSmartSystemSession(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage input smart systems.systemId
- the Id
of the System
proxy
- a proxy InputSmartSystemSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInputSmartSystem()
is false
optional
- This method must be implemented if
supportsInputSmartSystem()
is true.
SettingLookupSession getSettingLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the setting lookup
service.proxy
- a proxy SettingLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingLookup()
is false
optional
- This method must be implemented if
supportsSettingLookup()
is true.
SettingLookupSession getSettingLookupSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the setting lookup
service for the given system.systemId
- the Id
of the systemproxy
- a proxy SettingLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSettingLookup()
and
supportsVisibleFederation()
are true.
SettingQuerySession getSettingQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the setting query
service.proxy
- a proxy SettingQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingQuery()
is false
optional
- This method must be implemented if
supportsSettingQuery()
is true.
SettingQuerySession getSettingQuerySessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the setting query
service for the given system.systemId
- the Id
of the System
proxy
- a proxy SettingQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSettingQuery()
and
supportsVisibleFederation()
are true.
SettingSearchSession getSettingSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the setting search
service.proxy
- a proxy SettingSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingSearch()
is false
optional
- This method must be implemented if
supportsSettingSearch()
is true.
SettingSearchSession getSettingSearchSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the setting search
service for the given system.systemId
- the Id
of the System
proxy
- a proxy SettingSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSettingSearch()
and
supportsVisibleFederation()
are true.
SettingAdminSession getSettingAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the setting
administration service.proxy
- a proxy SettingAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingAdmin()
is false
optional
- This method must be implemented if
supportsSettingAdmin()
is true.
SettingAdminSession getSettingAdminSessionForInput(Id inputId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the setting
administration service for the given input.inputId
- the Id
of the Input
proxy
- a proxy SettingAdminSession
NotFoundException
- no input found by the given
Id
NullArgumentException
- inputId or proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSettingAdmin()
and
supportsVisibleFederation()
are true.
SettingNotificationSession getSettingNotificationSession(SettingReceiver settingReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the setting
notification service.settingReceiver
- the notification callbackproxy
- a proxy SettingNotificationSession
NullArgumentException
- settingReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSettingNotification()
is false
optional
- This method must be implemented if
supportsSettingNotification()
is true.
SettingNotificationSession getSettingNotificationSessionForSystem(SettingReceiver settingReceiver, Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the setting
notification service for the given system.settingReceiver
- the notification callbacksystemId
- the Id
of the System
proxy
- a proxy SettingNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- settingReceiver,
systemId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSettingNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSettingNotification()
and
supportsVisibleFederation()
are true.
SettingSystemSession getSettingSystemSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup setting/system mappings.proxy
- a proxy SettingSystemSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingSystem()
is false
optional
- This method must be implemented if
supportsSettingSystem()
is true.
SettingSystemAssignmentSession getSettingSystemAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning settings
to systems.proxy
- a proxy SettingSystemAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSettingSystemAssignment()
is false
optional
- This method must be implemented if
supportsSettingSystemAssignment()
is true.
SettingSmartSystemSession getSettingSmartSystemSession(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart systems.systemId
- the Id
of the System
proxy
- a proxy SettingSmartSystemSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSettingSmartSystem()
is false
optional
- This method must be implemented if
supportsSettingSmartSystem()
is true.
SceneLookupSession getSceneLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the scene lookup
service.proxy
- a proxy SceneLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneLookup()
is false
optional
- This method must be implemented if
supportsSceneLookup()
is true.
SceneLookupSession getSceneLookupSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the scene lookup
service for the given system.systemId
- the Id
of the systemproxy
- a proxy SceneLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSceneLookup()
and
supportsVisibleFederation()
are true.
SceneQuerySession getSceneQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the scene query
service.proxy
- a proxy SceneQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneQuery()
is false
optional
- This method must be implemented if
supportsSceneQuery()
is true.
SceneQuerySession getSceneQuerySessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the scene query
service for the given system.systemId
- the Id
of the System
proxy
- a proxy SceneQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSceneQuery()
and
supportsVisibleFederation()
are true.
SceneSearchSession getSceneSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the scene search
service.proxy
- a proxy SceneSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneSearch()
is false
optional
- This method must be implemented if
supportsSceneSearch()
is true.
SceneSearchSession getSceneSearchSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the scene search
service for the given system.systemId
- the Id
of the System
proxy
- a proxy SceneSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSceneSearch()
and
supportsVisibleFederation()
are true.
SceneAdminSession getSceneAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the scene
administration service.proxy
- a proxy SceneAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneAdmin()
is false
optional
- This method must be implemented if
supportsSceneAdmin()
is true.
SceneAdminSession getSceneAdminSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the scene
administration service for the given system.systemId
- the Id
of the System
proxy
- a proxy SceneAdminSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSceneAdmin()
and
supportsVisibleFederation()
are true.
SceneNotificationSession getSceneNotificationSession(SceneReceiver sceneReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the scene
notification service.sceneReceiver
- the notification callbackproxy
- a proxy SceneNotificationSession
NullArgumentException
- sceneReceiver
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSceneNotification()
is false
optional
- This method must be implemented if
supportsSceneNotification()
is true.
SceneNotificationSession getSceneNotificationSessionForSystem(SceneReceiver sceneReceiver, Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the scene
notification service for the given system.sceneReceiver
- the notification callbacksystemId
- the Id
of the System
proxy
- a proxy SceneNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- sceneReceiver,
systemId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSceneNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSceneNotification()
and
supportsVisibleFederation()
are true.
SceneSystemSession getSceneSystemSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup scene/system mappings.proxy
- a proxy SceneSystemSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneSystem()
is false
optional
- This method must be implemented if
supportsSceneSystem()
is true.
SceneSystemAssignmentSession getSceneSystemAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning scenes
to systems.proxy
- a proxy SceneSystemAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSceneSystemAssignment()
is false
optional
- This method must be implemented if
supportsSceneSystemAssignment()
is true.
SceneSmartSystemSession getSceneSmartSystemSession(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart systems.systemId
- the Id
of the System
proxy
- a proxy SceneSmartSystemSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSceneSmartSystem()
is false
optional
- This method must be implemented if
supportsSceneSmartSystem()
is true.
TriggerLookupSession getTriggerLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the trigger lookup
service.proxy
- a proxy TriggerLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerLookup()
is false
optional
- This method must be implemented if
supportsTriggerLookup()
is true.
TriggerLookupSession getTriggerLookupSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the trigger lookup
service for the given system.systemId
- the Id
of the System
proxy
- a proxy TriggerLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsTriggerLookup()
and
supportsVisibleFederation()
are true
TriggerQuerySession getTriggerQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the trigger query
service.proxy
- a proxy TriggerQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerQuery()
is false
optional
- This method must be implemented if
supportsTriggerQuery()
is true.
TriggerQuerySession getTriggerQuerySessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the trigger query
service for the given system.systemId
- the Id
of the System
proxy
- a proxy TriggerQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsTriggerQuery()
and
supportsVisibleFederation()
are true
TriggerSearchSession getTriggerSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the trigger search
service.proxy
- a proxy TriggerSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerSearch()
is false
optional
- This method must be implemented if
supportsTriggerSearch()
is true.
TriggerSearchSession getTriggerSearchSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the trigger search
service for the given system.systemId
- the Id
of the System
proxy
- a proxy TriggerSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsTriggerSearch()
and
supportsVisibleFederation()
are true
TriggerAdminSession getTriggerAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the trigger
administration service.proxy
- a proxy TriggerAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerAdmin()
is false
optional
- This method must be implemented if
supportsTriggerAdmin()
is true.
TriggerAdminSession getTriggerAdminSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the trigger
administration service for the given system.systemId
- the Id
of the System
proxy
- a proxy TriggerAdminSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsTriggerAdmin()
and
supportsVisibleFederation()
are true
TriggerNotificationSession getTriggerNotificationSession(TriggerReceiver triggerReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the trigger
notification service.triggerReceiver
- the notification callbackproxy
- a proxy TriggerNotificationSession
NullArgumentException
- triggerReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTriggerNotification()
is false
optional
- This method must be implemented if
supportsTriggerNotification()
is true.
TriggerNotificationSession getTriggerNotificationSessionForSystem(TriggerReceiver triggerReceiver, Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the trigger
notification service for the given system.triggerReceiver
- the notification callbacksystemId
- the Id
of the System
proxy
- a proxy TriggerNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- triggerReceiver,
systemId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTriggerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsTriggerNotification()
and
supportsVisibleFederation()
are true
TriggerSystemSession getTriggerSystemSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup trigger/system mappings.proxy
- a proxy TriggerSystemSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerSystem()
is false
optional
- This method must be implemented if
supportsTriggerSystem()
is true.
TriggerSystemAssignmentSession getTriggerSystemAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning triggers
to systems.proxy
- a proxy TriggerSystemAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTriggerSystemAssignment()
is false
optional
- This method must be implemented if
supportsTriggerSystemAssignment()
is true.
TriggerSmartSystemSession getTriggerSmartSystemSession(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage trigger smart systems.systemId
- the Id
of the System
proxy
- a proxy TriggerSmartSystemSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTriggerSmartSystem()
is false
optional
- This method must be implemented if
supportsTriggerSmartSystem()
is true.
ActionGroupLookupSession getActionGroupLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the action group
lookup service.proxy
- a proxy ActionGroupLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupLookup()
is false
optional
- This method must be implemented if
supportsActionGroupLookup()
is true.
ActionGroupLookupSession getActionGroupLookupSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the action group
lookup service for the given system.systemId
- the Id
of the System
proxy
- a proxy ActionGroupLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsActionGroupLookup()
and
supportsVisibleFederation()
are true
ActionGroupQuerySession getActionGroupQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the action group
query service.proxy
- a proxy ActionGroupQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupQuery()
is false
optional
- This method must be implemented if
supportsActionGroupQuery()
is true.
ActionGroupQuerySession getActionGroupQuerySessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the action group
query service for the given system.systemId
- the Id
of the System
proxy
- a proxy ActionGroupQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsActionGroupQuery()
and
supportsVisibleFederation()
are true
ActionGroupSearchSession getActionGroupSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the action group
search service.proxy
- a proxy ActionGroupSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupSearch()
is false
optional
- This method must be implemented if
supportsActionGroupSearch()
is true.
ActionGroupSearchSession getActionGroupSearchSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the action group
search service for the given system.systemId
- the Id
of the System
proxy
- a proxy ActionGroupSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsActionGroupSearch()
and
supportsVisibleFederation()
are true
ActionGroupAdminSession getActionGroupAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the action group
administration service.proxy
- a proxy ActionGroupAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupAdmin()
is false
optional
- This method must be implemented if
supportsActionGroupAdmin()
is true.
ActionGroupAdminSession getActionGroupAdminSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the action group
administration service for the given system.systemId
- the Id
of the System
proxy
- a proxy ActionGroupAdminSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsActionGroupAdmin()
and
supportsVisibleFederation()
are true
ActionGroupNotificationSession getActionGroupNotificationSession(ActionGroupReceiver actionGroupReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the action group
notification service.actionGroupReceiver
- the notification callbackproxy
- a proxy ActionGroupNotificationSession
NullArgumentException
- actionGroupReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupNotification()
is false
optional
- This method must be implemented if
supportsActionGroupNotification()
is true.
ActionGroupNotificationSession getActionGroupNotificationSessionForSystem(ActionGroupReceiver actionGroupReceiver, Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the action group
notification service for the given system.actionGroupReceiver
- the notification callbacksystemId
- the Id
of the System
proxy
- a proxy ActionGroupNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- actionGroupReceiver,
systemId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsActionGroupNotification()
and
supportsVisibleFederation()
are true
ActionGroupSystemSession getActionGroupSystemSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup action group/system
mappings.proxy
- a proxy ActionGroupSystemSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupSystem()
is false
optional
- This method must be implemented if
supportsActionGroupSystem()
is true.
ActionGroupSystemAssignmentSession getActionGroupSystemAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning action
groups to systems.proxy
- a proxy ActionGroupSystemAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupSystemAssignment()
is false
optional
- This method must be implemented if
supportsActionGroupSystemAssignment()
is
true.
ActionGroupSmartSystemSession getActionGroupSmartSystemSession(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage action group smart
systems.systemId
- the Id
of the System
proxy
- a proxy ActionGroupSmartSystemSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupSmartSystem()
is false
optional
- This method must be implemented if
supportsActionGroupSmartSystem()
is true.
SystemLookupSession getSystemLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the system lookup
service.proxy
- a proxy SystemLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSystemLookup()
is false
optional
- This method must be implemented if
supportsSystemLookup()
is true.
SystemQuerySession getSystemQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the system query
service.proxy
- a proxy SystemQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSystemQuery()
is false
optional
- This method must be implemented if
supportsSystemQuery()
is true.
SystemSearchSession getSystemSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the system search
service.proxy
- a proxy SystemSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSystemSearch()
is false
optional
- This method must be implemented if
supportsSystemSearch()
is true.
SystemAdminSession getSystemAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the system
administrative service.proxy
- a proxy SystemAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSystemAdmin()
is false
optional
- This method must be implemented if
supportsSystemAdmin()
is true.
SystemNotificationSession getSystemNotificationSession(SystemReceiver systemReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the system
notification service.systemReceiver
- the notification callbackproxy
- a proxy SystemNotificationSession
NullArgumentException
- systemReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSystemNotification()
is false
optional
- This method must be implemented if
supportsSystemNotification()
is true.
SystemHierarchySession getSystemHierarchySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the system
hierarchy service.proxy
- a proxy SystemHierarchySession
for systemsNullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSystemHierarchy()
is false
optional
- This method must be implemented if
supportsSystemHierarchy()
is true.
SystemHierarchyDesignSession getSystemHierarchyDesignSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the system
hierarchy design service.proxy
- a proxy HierarchyDesignSession
for systemsNullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSystemHierarchyDesign()
is false
optional
- This method must be implemented if
supportsSystemHierarchyDesign()
is true.
ControlBatchProxyManager getControlBatchProxyManager() throws OperationFailedException
ControlBatchProxyManager.
ControlBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsControlBatch()
is false
optional
- This method must be implemented if
supportsControlBatch()
is true.
ControlRulesProxyManager getControlRulesProxyManager() throws OperationFailedException
ControlRulesProxyManager.
ControlRulesProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsControlRules()
is false
optional
- This method must be implemented if
supportsControlRules()
is true.