org.osid.control.batch

Interface ControlBatchProxyManager

All Superinterfaces:

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

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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.control.batch.ControlBatchProfile

supportsActionGroupBatchAdmin, supportsControllerBatchAdmin, supportsDeviceBatchAdmin, supportsInputBatchAdmin, supportsSceneBatchAdmin, supportsSettingBatchAdmin, supportsSystemBatchAdmin, supportsTriggerBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getDeviceBatchAdminSession

DeviceBatchAdminSession getDeviceBatchAdminSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk device administration service.

Parameters:

proxy - a proxy

Returns:

a DeviceBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceBatchAdmin() is false

Compliance:

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

getDeviceBatchAdminSessionForSystem

DeviceBatchAdminSession getDeviceBatchAdminSessionForSystem(Id systemId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a DeviceBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getControllerBatchAdminSession

ControllerBatchAdminSession getControllerBatchAdminSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk controller administration service.

Parameters:

proxy - a proxy

Returns:

a ControllerBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerBatchAdmin() is false

Compliance:

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

getControllerBatchAdminSessionForSystem

ControllerBatchAdminSession getControllerBatchAdminSessionForSystem(Id systemId,
                                                                  Proxy proxy)
                                                                    throws NotFoundException,
                                                                           OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a ControllerBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsControllerBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getInputBatchAdminSession

InputBatchAdminSession getInputBatchAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk input administration service.

Parameters:

proxy - a proxy

Returns:

an InputBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputBatchAdmin() is false

Compliance:

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

getInputBatchAdminSessionForSystem

InputBatchAdminSession getInputBatchAdminSessionForSystem(Id systemId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

an InputBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getSettingBatchAdminSession

SettingBatchAdminSession getSettingBatchAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk setting administration service.

Parameters:

proxy - a proxy

Returns:

a SettingBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingBatchAdmin() is false

Compliance:

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

getSettingBatchAdminSessionForSystem

SettingBatchAdminSession getSettingBatchAdminSessionForSystem(Id systemId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a SettingBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSettingBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getSceneBatchAdminSession

SceneBatchAdminSession getSceneBatchAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk scene administration service.

Parameters:

proxy - a proxy

Returns:

a SceneBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneBatchAdmin() is false

Compliance:

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

getSceneBatchAdminSessionForSystem

SceneBatchAdminSession getSceneBatchAdminSessionForSystem(Id systemId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a SceneBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSceneBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getTriggerBatchAdminSession

TriggerBatchAdminSession getTriggerBatchAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk trigger administration service.

Parameters:

proxy - a proxy

Returns:

a TriggerBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerBatchAdmin() is false

Compliance:

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

getTriggerBatchAdminSessionForSystem

TriggerBatchAdminSession getTriggerBatchAdminSessionForSystem(Id systemId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

a TriggerBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getActionGroupBatchAdminSession

ActionGroupBatchAdminSession getActionGroupBatchAdminSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the bulk action group administration service.

Parameters:

proxy - a proxy

Returns:

an ActionGroupBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupBatchAdmin() is false

Compliance:

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

getActionGroupBatchAdminSessionForSystem

ActionGroupBatchAdminSession getActionGroupBatchAdminSessionForSystem(Id systemId,
                                                                    Proxy proxy)
                                                                      throws NotFoundException,
                                                                             OperationFailedException

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

Parameters:

systemId - the Id of the System

proxy - a proxy

Returns:

an ActionGroupBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionGroupBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getSystemBatchAdminSession

SystemBatchAdminSession getSystemBatchAdminSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk system administration service.

Parameters:

proxy - a proxy

Returns:

a SystemBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemBatchAdmin() is false

Compliance:

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