Interface ControlBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, ControlBatchProfile, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface ControlBatchProfile

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

Modifier and Type	Method	Description
boolean	supportsActionGroupBatchAdmin()	Tests if bulk administration of action groups is available.
boolean	supportsControllerBatchAdmin()	Tests if bulk administration of controllers is available.
boolean	supportsDeviceBatchAdmin()	Tests if bulk administration of devices is available.
boolean	supportsInputBatchAdmin()	Tests if bulk administration of inputs is available.
boolean	supportsSceneBatchAdmin()	Tests if bulk administration of scenes is available.
boolean	supportsSettingBatchAdmin()	Tests if bulk administration of setting is available.
boolean	supportsSystemBatchAdmin()	Tests if bulk administration of systems is available.
boolean	supportsTriggerBatchAdmin()	Tests if bulk administration of triggers is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsDeviceBatchAdmin()} is {@code 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 {@code supportsDeviceBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsControllerBatchAdmin()} is {@code 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 {@code supportsControllerBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInputBatchAdmin()} is {@code 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 {@code supportsInputBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsSettingBatchAdmin()} is {@code 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 {@code supportsSettingBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsSceneBatchAdmin()} is {@code 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 {@code supportsSceneBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTriggerBatchAdmin()} is {@code 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 {@code supportsTriggerBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsActionGroupBatchAdmin()} is {@code 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 {@code supportsActionGroupBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsSystemBatchAdmin()} is {@code true} .