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 Modifier and Type | Method and 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. |
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() throws OperationFailedException
OsidSession
associated with the device lookup
service. DeviceLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceLookup()
is false
optional
- This method must be implemented if
supportsDeviceLookup()
is true.
DeviceLookupSession getDeviceLookupSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the device lookup
service for the given system.systemId
- the Id
of the System
DeviceLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the device query
service. DeviceQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceQuery()
is false
optional
- This method must be implemented if
supportsDeviceQuery()
is true.
DeviceQuerySession getDeviceQuerySessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the device query
service for the given system.systemId
- the Id
of the System
DeviceQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the device search
service. DeviceSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceSearch()
is false
optional
- This method must be implemented if
supportsDeviceSearch()
is true.
DeviceSearchSession getDeviceSearchSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the device search
service for the given system.systemId
- the Id
of the System
DeviceSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the device
administration service. DeviceAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceAdmin()
is false
optional
- This method must be implemented if
supportsDeviceAdmin()
is true.
DeviceAdminSession getDeviceAdminSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the device
administration service for the given system.systemId
- the Id
of the System
DeviceAdminSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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) throws OperationFailedException
OsidSession
associated with the device
notification service.deviceReceiver
- the notification callback DeviceNotificationSession
NullArgumentException
- deviceReceiver
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) throws NotFoundException, OperationFailedException
OsidSession
associated with the device
notification service for the given system.deviceReceiver
- the notification callbacksystemId
- the Id
of the System
DeviceNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- deviceReceiver
or systemId
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() throws OperationFailedException
OsidSession
to lookup device/system mappings. DeviceSystemSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeviceSystem()
is false
optional
- This method must be implemented if
supportsDeviceSystem()
is true.
DeviceSystemAssignmentSession getDeviceSystemAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning devices
to systems. DeviceSystemAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDeviceSystemAssignment()
is false
optional
- This method must be implemented if
supportsDeviceSystemAssignment()
is true.
DeviceSmartSystemSession getDeviceSmartSystemSession(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
to manage device smart systems.systemId
- the Id
of the System
DeviceSmartSystemSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDeviceSmartSystem()
is false
optional
- This method must be implemented if
supportsDeviceSmartSystem()
is true.
ControllerLookupSession getControllerLookupSession() throws OperationFailedException
OsidSession
associated with the controller
lookup service. ControllerLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerLookup()
is false
optional
- This method must be implemented if
supportsControllerLookup()
is true.
ControllerLookupSession getControllerLookupSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the controller
lookup service for the given system.systemId
- the Id
of the System
ControllerLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the controller
query service. ControllerQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerQuery()
is false
optional
- This method must be implemented if
supportsControllerQuery()
is true.
ControllerQuerySession getControllerQuerySessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the controller
query service for the given system.systemId
- the Id
of the System
ControllerQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the controller
search service. ControllerSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerSearch()
is false
optional
- This method must be implemented if
supportsControllerSearch()
is true.
ControllerSearchSession getControllerSearchSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the controller
search service for the given system.systemId
- the Id
of the System
ControllerSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the controller
administration service. ControllerAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerAdmin()
is false
optional
- This method must be implemented if
supportsControllerAdmin()
is true.
ControllerAdminSession getControllerAdminSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the controller
administration service for the given system.systemId
- the Id
of the System
ControllerAdminSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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) throws OperationFailedException
OsidSession
associated with the controller
notification service.controllerReceiver
- the notification callback ControllerNotificationSession
NullArgumentException
- controllerReceiver
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) throws NotFoundException, OperationFailedException
OsidSession
associated with the controller
notification service for the given system.controllerReceiver
- the notification callbacksystemId
- the Id
of the System
ControllerNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- controllerReceiver
or systemId
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() throws OperationFailedException
OsidSession
to lookup controller/system
mappings. ControllerSystemSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerSystem()
is false
optional
- This method must be implemented if
supportsControllerSystem()
is true.
ControllerSystemAssignmentSession getControllerSystemAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
controllers to systems. ControllerSystemAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerSystemAssignment()
is false
optional
- This method must be implemented if
supportsControllerSystemAssignment()
is
true.
ControllerSmartSystemSession getControllerSmartSystemSession(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
to manage controller smart
systems.systemId
- the Id
of the system ControllerSmartSystemSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerSmartSystem()
is false
optional
- This method must be implemented if
supportsControllerSmartSystem()
is true.
InputLookupSession getInputLookupSession() throws OperationFailedException
OsidSession
associated with the input lookup
service. InputLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputLookup()
is false
optional
- This method must be implemented if
supportsInputLookup()
is true.
InputLookupSession getInputLookupSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the input lookup
service for the given system.systemId
- the Id
of the System
InputLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the input query
service. InputQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputQuery()
is false
optional
- This method must be implemented if
supportsInputQuery()
is true.
InputQuerySession getInputQuerySessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the input query
service for the given system.systemId
- the Id
of the System
InputQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the input search
service. InputSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputSearch()
is false
optional
- This method must be implemented if
supportsInputSearch()
is true.
InputSearchSession getInputSearchSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the input search
service for the given system.systemId
- the Id
of the System
InputSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the input
administration service. InputAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputAdmin()
is false
optional
- This method must be implemented if
supportsInputAdmin()
is true.
InputAdminSession getInputAdminSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the input
administration service for the given system.systemId
- the Id
of the System
InputAdminSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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) throws OperationFailedException
OsidSession
associated with the input
notification service.inputReceiver
- the notification callback InputNotificationSession
NullArgumentException
- inputReceiver
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) throws NotFoundException, OperationFailedException
OsidSession
associated with the input
notification service for the given system.inputReceiver
- the notification callbacksystemId
- the Id
of the System
InputNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- inputReceiver
or
systemId
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() throws OperationFailedException
OsidSession
to lookup input/system mappings. InputSystemSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInputSystem()
is false
optional
- This method must be implemented if
supportsInputSystem()
is true.
InputSystemAssignmentSession getInputSystemAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning inputs
to systems. InputSystemAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInputSystemAssignment()
is false
optional
- This method must be implemented if
supportsInputSystemAssignment()
is true.
InputSmartSystemSession getInputSmartSystemSession(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
to manage input smart systems.systemId
- the Id
of the System
InputSmartSystemSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInputSmartSystem()
is false
optional
- This method must be implemented if
supportsInputSmartSystem()
is true.
SettingLookupSession getSettingLookupSession() throws OperationFailedException
OsidSession
associated with the setting lookup
service. SettingLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingLookup()
is false
optional
- This method must be implemented if
supportsSettingLookup()
is true.
SettingLookupSession getSettingLookupSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the setting lookup
service for the given system.systemId
- the Id
of the system SettingLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the setting query
service. SettingQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingQuery()
is false
optional
- This method must be implemented if
supportsSettingQuery()
is true.
SettingQuerySession getSettingQuerySessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the setting query
service for the given system.systemId
- the Id
of the System
SettingQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the setting search
service. SettingSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingSearch()
is false
optional
- This method must be implemented if
supportsSettingSearch()
is true.
SettingSearchSession getSettingSearchSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the setting search
service for the given system.systemId
- the Id
of the System
SettingSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the setting
administration service. SettingAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingAdmin()
is false
optional
- This method must be implemented if
supportsSettingAdmin()
is true.
SettingAdminSession getSettingAdminSessionForInput(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the setting
administration service for the given system.systemId
- the Id
of the Dostributor
SettingAdminSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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) throws OperationFailedException
OsidSession
associated with the setting
notification service.settingReceiver
- the notification callback SettingNotificationSession
NullArgumentException
- settingReceiver
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) throws NotFoundException, OperationFailedException
OsidSession
associated with the setting
notification service for the given system.settingReceiver
- the notification callbacksystemId
- the Id
of the System
SettingNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- settingReceiver
or systemId
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() throws OperationFailedException
OsidSession
to lookup setting/system mappings. SettingSystemSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSettingSystem()
is false
optional
- This method must be implemented if
supportsSettingSystem()
is true.
SettingSystemAssignmentSession getSettingSystemAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning settings
to systems. SettingSystemAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSettingSystemAssignment()
is false
optional
- This method must be implemented if
supportsSettingSystemAssignment()
is true.
SettingSmartSystemSession getSettingSmartSystemSession(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart systems.systemId
- the Id
of the System
SettingSmartSystemSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSettingSmartSystem()
is false
optional
- This method must be implemented if
supportsSettingSmartSystem()
is true.
SceneLookupSession getSceneLookupSession() throws OperationFailedException
OsidSession
associated with the scene lookup
service. SceneLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneLookup()
is false
optional
- This method must be implemented if
supportsSceneLookup()
is true.
SceneLookupSession getSceneLookupSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the scene lookup
service for the given system.systemId
- the Id
of the system SceneLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the scene query
service. SceneQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneQuery()
is false
optional
- This method must be implemented if
supportsSceneQuery()
is true.
SceneQuerySession getSceneQuerySessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the scene query
service for the given system.systemId
- the Id
of the System
SceneQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the scene search
service. SceneSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneSearch()
is false
optional
- This method must be implemented if
supportsSceneSearch()
is true.
SceneSearchSession getSceneSearchSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the scene search
service for the given system.systemId
- the Id
of the System
SceneSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the scene
administration service. SceneAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneAdmin()
is false
optional
- This method must be implemented if
supportsSceneAdmin()
is true.
SceneAdminSession getSceneAdminSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the scene
administration service for the given system.systemId
- the Id
of the Dostributor
SceneAdminSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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) throws OperationFailedException
OsidSession
associated with the scene
notification service.sceneReceiver
- the notification callback SceneNotificationSession
NullArgumentException
- sceneReceiver
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) throws NotFoundException, OperationFailedException
OsidSession
associated with the scene
notification service for the given system.sceneReceiver
- the notification callbacksystemId
- the Id
of the System
SceneNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- sceneReceiver
or
systemId
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() throws OperationFailedException
OsidSession
to lookup scene/system mappings. SceneSystemSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSceneSystem()
is false
optional
- This method must be implemented if
supportsSceneSystem()
is true.
SceneSystemAssignmentSession getSceneSystemAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning scenes
to systems. SceneSystemAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSceneSystemAssignment()
is false
optional
- This method must be implemented if
supportsSceneSystemAssignment()
is true.
SceneSmartSystemSession getSceneSmartSystemSession(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart systems.systemId
- the Id
of the System
SceneSmartSystemSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSceneSmartSystem()
is false
optional
- This method must be implemented if
supportsSceneSmartSystem()
is true.
TriggerLookupSession getTriggerLookupSession() throws OperationFailedException
OsidSession
associated with the trigger lookup
service. TriggerLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerLookup()
is false
optional
- This method must be implemented if
supportsTriggerLookup()
is true.
TriggerLookupSession getTriggerLookupSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the trigger lookup
service for the given system.systemId
- the Id
of the System
TriggerLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the trigger query
service. TriggerQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerQuery()
is false
optional
- This method must be implemented if
supportsTriggerQuery()
is true.
TriggerQuerySession getTriggerQuerySessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the trigger query
service for the given system.systemId
- the Id
of the System
TriggerQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the trigger search
service. TriggerSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerSearch()
is false
optional
- This method must be implemented if
supportsTriggerSearch()
is true.
TriggerSearchSession getTriggerSearchSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the trigger search
service for the given system.systemId
- the Id
of the System
TriggerSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the trigger
administration service. TriggerAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerAdmin()
is false
optional
- This method must be implemented if
supportsTriggerAdmin()
is true.
TriggerAdminSession getTriggerAdminSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the trigger
administration service for the given system.systemId
- the Id
of the System
TriggerAdminSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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) throws OperationFailedException
OsidSession
associated with the trigger
notification service.triggerReceiver
- the notification callback TriggerNotificationSession
NullArgumentException
- triggerReceiver
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) throws NotFoundException, OperationFailedException
OsidSession
associated with the trigger
notification service for the given system.triggerReceiver
- the notification callbacksystemId
- the Id
of the System
TriggerNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- triggerReceiver
or systemId
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() throws OperationFailedException
OsidSession
to lookup trigger/system mappings. TriggerSystemSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsTriggerSystem()
is false
optional
- This method must be implemented if
supportsTriggerSystem()
is true.
TriggerSystemAssignmentSession getTriggerSystemAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning triggers
to systems. TriggerSystemAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTriggerSystemAssignment()
is false
optional
- This method must be implemented if
supportsTriggerSystemAssignment()
is true.
TriggerSmartSystemSession getTriggerSmartSystemSession(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
to manage trigger smart systems.systemId
- the Id
of the System
TriggerSmartSystemSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTriggerSmartSystem()
is false
optional
- This method must be implemented if
supportsTriggerSmartSystem()
is true.
ActionGroupLookupSession getActionGroupLookupSession() throws OperationFailedException
OsidSession
associated with the action group
lookup service. ActionGroupLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupLookup()
is false
optional
- This method must be implemented if
supportsActionGroupLookup()
is true.
ActionGroupLookupSession getActionGroupLookupSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the action group
lookup service for the given system.systemId
- the Id
of the System
ActionGroupLookupSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the action group
query service. ActionGroupQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupQuery()
is false
optional
- This method must be implemented if
supportsActionGroupQuery()
is true.
ActionGroupQuerySession getActionGroupQuerySessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the action group
query service for the given system.systemId
- the Id
of the System
ActionGroupQuerySession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the action group
search service. ActionGroupSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupSearch()
is false
optional
- This method must be implemented if
supportsActionGroupSearch()
is true.
ActionGroupSearchSession getActionGroupSearchSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the action group
search service for the given system.systemId
- the Id
of the System
ActionGroupSearchSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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() throws OperationFailedException
OsidSession
associated with the action group
administration service. ActionGroupAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupAdmin()
is false
optional
- This method must be implemented if
supportsActionGroupAdmin()
is true.
ActionGroupAdminSession getActionGroupAdminSessionForSystem(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
associated with the action group
administration service for the given system.systemId
- the Id
of the System
ActionGroupAdminSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- systemId
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) throws OperationFailedException
OsidSession
associated with the action group
notification service.actionGroupReceiver
- the notification callback ActionGroupNotificationSession
NullArgumentException
- actionGroupReceiver
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) throws NotFoundException, OperationFailedException
OsidSession
associated with the action group
notification service for the given system.actionGroupReceiver
- the notification callbacksystemId
- the Id
of the System
ActionGroupNotificationSession
NotFoundException
- no system found by the given
Id
NullArgumentException
- actionGroupReceiver
or systemId
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() throws OperationFailedException
OsidSession
to lookup action group/system
mappings. ActionGroupSystemSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupSystem()
is false
optional
- This method must be implemented if
supportsActionGroupSystem()
is true.
ActionGroupSystemAssignmentSession getActionGroupSystemAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning action
groups to systems. ActionGroupSystemAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupSystemAssignment()
is false
optional
- This method must be implemented if
supportsActionGroupSystemAssignment()
is
true.
ActionGroupSmartSystemSession getActionGroupSmartSystemSession(Id systemId) throws NotFoundException, OperationFailedException
OsidSession
to manage action group smart
systems.systemId
- the Id
of the System
ActionGroupSmartSystemSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupSmartSystem()
is false
optional
- This method must be implemented if
supportsActionGroupSmartSystem()
is true.
SystemLookupSession getSystemLookupSession() throws OperationFailedException
OsidSession
associated with the system lookup
service. SystemLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSystemLookup()
is false
optional
- This method must be implemented if
supportsSystemLookup()
is true.
SystemQuerySession getSystemQuerySession() throws OperationFailedException
OsidSession
associated with the system query
service. SystemQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSystemQuery()
is false
optional
- This method must be implemented if
supportsSystemQuery()
is true.
SystemSearchSession getSystemSearchSession() throws OperationFailedException
OsidSession
associated with the system search
service. SystemSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSystemSearch()
is false
optional
- This method must be implemented if
supportsSystemSearch()
is true.
SystemAdminSession getSystemAdminSession() throws OperationFailedException
OsidSession
associated with the system
administrative service. SystemAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSystemAdmin()
is false
optional
- This method must be implemented if
supportsSystemAdmin()
is true.
SystemNotificationSession getSystemNotificationSession(SystemReceiver systemReceiver) throws OperationFailedException
OsidSession
associated with the system
notification service.systemReceiver
- the notification callback SystemNotificationSession
NullArgumentException
- systemReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSystemNotification()
is false
optional
- This method must be implemented if
supportsSystemNotification()
is true.
SystemHierarchySession getSystemHierarchySession() throws OperationFailedException
OsidSession
associated with the system
hierarchy service. SystemHierarchySession
for systemsOperationFailedException
- unable to complete requestUnimplementedException
-
supportsSystemHierarchy()
is false
optional
- This method must be implemented if
supportsSystemHierarchy()
is true.
SystemHierarchyDesignSession getSystemHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the system
hierarchy design service. HierarchyDesignSession
for systemsOperationFailedException
- unable to complete requestUnimplementedException
-
supportsSystemHierarchyDesign()
is false
optional
- This method must be implemented if
supportsSystemHierarchyDesign()
is true.
ControlBatchManager getControlBatchManager() throws OperationFailedException
ControlBatchManager.
ControlBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsControlBatch()
is false
optional
- This method must be implemented if
supportsControlBatch()
is true.
ControlRulesManager getControlRulesManager() throws OperationFailedException
ControlRulesManager.
ControlRulesManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsControlRules()
is false
optional
- This method must be implemented if
supportsControlRules()
is true.