public interface ControlBatchProxyManager extends OsidProxyManager, ControlBatchProfile
The control batch manager provides access to control batch sessions and
provides interoperability tests for various aspects of this service.
Methods in this manager support the passing of a Proxy
object. The sessions included in this manager are:
DeviceBatchAdminSession:
a session to create,
modify and delete Devices
in bulk ControllerBatchAdminSession: a session to create, modify
and delete Controllers in bulk
InputBatchAdminSession:
a session to create,
modify and delete Inputs in bulk SettingBatchAdminSession:
a session to create,
modify and delete Settings
in bulk SceneBatchAdminSession:
a session to create,
modify and delete Scenes
in bulk TriggerBatchAdminSession:
a session to create,
modify and delete Triggers
in bulk ActionGroupBatchAdminSession:
a session to create,
modify and delete ActionGroups
in bulk SystemBatchAdminSession:
a session to create,
modify and delete Systems
in bulk Modifier and Type | Method and Description |
---|---|
ActionGroupBatchAdminSession |
getActionGroupBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk action
group administration service. |
ActionGroupBatchAdminSession |
getActionGroupBatchAdminSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the bulk action
group administration service for the given system. |
ControllerBatchAdminSession |
getControllerBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk
controller administration service. |
ControllerBatchAdminSession |
getControllerBatchAdminSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the bulk
controller administration service for the given system. |
DeviceBatchAdminSession |
getDeviceBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk device
administration service. |
DeviceBatchAdminSession |
getDeviceBatchAdminSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the bulk device
administration service for the given system. |
InputBatchAdminSession |
getInputBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk input
administration service. |
InputBatchAdminSession |
getInputBatchAdminSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the bulk input
administration service for the given system. |
SceneBatchAdminSession |
getSceneBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk scene
administration service. |
SceneBatchAdminSession |
getSceneBatchAdminSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the bulk scene
administration service for the given system. |
SettingBatchAdminSession |
getSettingBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk setting
administration service. |
SettingBatchAdminSession |
getSettingBatchAdminSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the bulk setting
administration service for the given system. |
SystemBatchAdminSession |
getSystemBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk system
administration service. |
TriggerBatchAdminSession |
getTriggerBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk trigger
administration service. |
TriggerBatchAdminSession |
getTriggerBatchAdminSessionForSystem(Id systemId,
Proxy proxy)
Gets the
OsidSession associated with the bulk trigger
administration service for the given system. |
changeBranch, initialize, rollbackService
close
supportsActionGroupBatchAdmin, supportsControllerBatchAdmin, supportsDeviceBatchAdmin, supportsInputBatchAdmin, supportsSceneBatchAdmin, supportsSettingBatchAdmin, supportsSystemBatchAdmin, supportsTriggerBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
DeviceBatchAdminSession getDeviceBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk device
administration service.proxy
- a proxy DeviceBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDeviceBatchAdmin()
is false
optional
- This method must be implemented if
supportsDeviceBatchAdmin()
is true.
DeviceBatchAdminSession getDeviceBatchAdminSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk device
administration service for the given system.systemId
- the Id
of the System
proxy
- a proxy DeviceBatchAdminSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDeviceBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDeviceBatchAdmin()
and
supportsVisibleFederation()
are true
ControllerBatchAdminSession getControllerBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk
controller administration service.proxy
- a proxy ControllerBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerBatchAdmin()
is false
optional
- This method must be implemented if
supportsControllerBatchAdmin()
is true.
ControllerBatchAdminSession getControllerBatchAdminSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
controller administration service for the given system.systemId
- the Id
of the System
proxy
- a proxy ControllerBatchAdminSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsControllerBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsControllerBatchAdmin()
and
supportsVisibleFederation()
are true
InputBatchAdminSession getInputBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk input
administration service.proxy
- a proxy InputBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInputBatchAdmin()
is false
optional
- This method must be implemented if
supportsInputBatchAdmin()
is true.
InputBatchAdminSession getInputBatchAdminSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk input
administration service for the given system.systemId
- the Id
of the System
proxy
- a proxy InputBatchAdminSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInputBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsInputBatchAdmin()
and
supportsVisibleFederation()
are true
SettingBatchAdminSession getSettingBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk setting
administration service.proxy
- a proxy SettingBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSettingBatchAdmin()
is false
optional
- This method must be implemented if
supportsSettingBatchAdmin()
is true.
SettingBatchAdminSession getSettingBatchAdminSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk setting
administration service for the given system.systemId
- the Id
of the System
proxy
- a proxy SettingBatchAdminSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSettingBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSettingBatchAdmin()
and
supportsVisibleFederation()
are true
SceneBatchAdminSession getSceneBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk scene
administration service.proxy
- a proxy SceneBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSceneBatchAdmin()
is false
optional
- This method must be implemented if
supportsSceneBatchAdmin()
is true.
SceneBatchAdminSession getSceneBatchAdminSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk scene
administration service for the given system.systemId
- the Id
of the System
proxy
- a proxy SceneBatchAdminSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSceneBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSceneBatchAdmin()
and
supportsVisibleFederation()
are true
TriggerBatchAdminSession getTriggerBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk trigger
administration service.proxy
- a proxy TriggerBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTriggerBatchAdmin()
is false
optional
- This method must be implemented if
supportsTriggerBatchAdmin()
is true.
TriggerBatchAdminSession getTriggerBatchAdminSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk trigger
administration service for the given system.systemId
- the Id
of the System
proxy
- a proxy TriggerBatchAdminSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTriggerBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsTriggerBatchAdmin()
and
supportsVisibleFederation()
are true
ActionGroupBatchAdminSession getActionGroupBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk action
group administration service.proxy
- a proxy ActionGroupBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupBatchAdmin()
is false
optional
- This method must be implemented if
supportsActionGroupBatchAdmin()
is true.
ActionGroupBatchAdminSession getActionGroupBatchAdminSessionForSystem(Id systemId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk action
group administration service for the given system.systemId
- the Id
of the System
proxy
- a proxy ActionGroupBatchAdminSession
NotFoundException
- no System
found by
the given Id
NullArgumentException
- systemId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsActionGroupBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsActionGroupBatchAdmin()
and
supportsVisibleFederation()
are true
SystemBatchAdminSession getSystemBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk system
administration service.proxy
- a proxy SystemBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSystemBatchAdmin()
is false
optional
- This method must be implemented if
supportsSystemBatchAdmin()
is true.