org.osid.control.batch

Interface ControlBatchManager

All Superinterfaces:

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

public interface ControlBatchManager
extends OsidManager, ControlBatchProfile

The control batch manager provides access to control batch sessions and provides interoperability tests for various aspects of this service. 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() Gets the OsidSession associated with the bulk action group administration service.
ActionGroupBatchAdminSession	getActionGroupBatchAdminSessionForSystem(Id systemId) Gets the OsidSession associated with the bulk action group administration service for the given system.
ControllerBatchAdminSession	getControllerBatchAdminSession() Gets the OsidSession associated with the bulk controller administration service.
ControllerBatchAdminSession	getControllerBatchAdminSessionForSystem(Id systemId) Gets the OsidSession associated with the bulk controller administration service for the given system.
DeviceBatchAdminSession	getDeviceBatchAdminSession() Gets the OsidSession associated with the bulk device administration service.
DeviceBatchAdminSession	getDeviceBatchAdminSessionForSystem(Id systemId) Gets the OsidSession associated with the bulk device administration service for the given system.
InputBatchAdminSession	getInputBatchAdminSession() Gets the OsidSession associated with the bulk input administration service.
InputBatchAdminSession	getInputBatchAdminSessionForSystem(Id systemId) Gets the OsidSession associated with the bulk input administration service for the given system.
SceneBatchAdminSession	getSceneBatchAdminSession() Gets the OsidSession associated with the bulk scene administration service.
SceneBatchAdminSession	getSceneBatchAdminSessionForSystem(Id systemId) Gets the OsidSession associated with the bulk scene administration service for the given system.
SettingBatchAdminSession	getSettingBatchAdminSession() Gets the OsidSession associated with the bulk setting administration service.
SettingBatchAdminSession	getSettingBatchAdminSessionForSystem(Id systemId) Gets the OsidSession associated with the bulk setting administration service for the given system.
SystemBatchAdminSession	getSystemBatchAdminSession() Gets the OsidSession associated with the bulk system administration service.
TriggerBatchAdminSession	getTriggerBatchAdminSession() Gets the OsidSession associated with the bulk trigger administration service.
TriggerBatchAdminSession	getTriggerBatchAdminSessionForSystem(Id systemId) Gets the OsidSession associated with the bulk trigger administration service for the given system.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk device administration service.

Returns:

a DeviceBatchAdminSession

Throws:

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)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a DeviceBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId 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()
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk controller administration service.

Returns:

a ControllerBatchAdminSession

Throws:

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)
                                                                    throws NotFoundException,
                                                                           OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a ControllerBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId 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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk input administration service.

Returns:

an InputBatchAdminSession

Throws:

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)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an InputBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId 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()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk setting administration service.

Returns:

a SettingBatchAdminSession

Throws:

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)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a SettingBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId 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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk scene administration service.

Returns:

a SceneBatchAdminSession

Throws:

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)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a SceneBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId 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()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk trigger administration service.

Returns:

a TriggerBatchAdminSession

Throws:

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)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a TriggerBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId 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()
                                                             throws OperationFailedException

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

Returns:

an ActionGroupBatchAdminSession

Throws:

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)
                                                                      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

Returns:

an ActionGroupBatchAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId 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()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk system administration service.

Returns:

a SystemBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSystemBatchAdmin() is false

Compliance:

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