OSID - osid.control.batch.ControlBatchManager Service Interface Definition

Interface	osid.control.batch.ControlBatchManager
Implements	`osid.OsidManager`
Implements	`osid.control.batch.ControlBatchProfile`
Description	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	getDeviceBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk device administration service.
Return	`osid.control.batch.DeviceBatchAdminSession`		a `DeviceBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDeviceBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeviceBatchAdmin()` is `true.`
Method	getDeviceBatchAdminSessionForSystem
Description	Gets the `OsidSession` associated with the bulk device administration service for the given system.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System`
Return	`osid.control.batch.DeviceBatchAdminSession`		a `DeviceBatchAdminSession`
Errors	NOT_FOUND		no `System` found by the given `Id`
	NULL_ARGUMENT		`systemId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDeviceBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeviceBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getControllerBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk controller administration service.
Return	`osid.control.batch.ControllerBatchAdminSession`		a `ControllerBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsControllerBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsControllerBatchAdmin()` is `true.`
Method	getControllerBatchAdminSessionForSystem
Description	Gets the `OsidSession` associated with the bulk controller administration service for the given system.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System`
Return	`osid.control.batch.ControllerBatchAdminSession`		a `ControllerBatchAdminSession`
Errors	NOT_FOUND		no `System` found by the given `Id`
	NULL_ARGUMENT		`systemId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsControllerBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsControllerBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getInputBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk input administration service.
Return	`osid.control.batch.InputBatchAdminSession`		an `InputBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInputBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInputBatchAdmin()` is `true.`
Method	getInputBatchAdminSessionForSystem
Description	Gets the `OsidSession` associated with the bulk input administration service for the given system.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System`
Return	`osid.control.batch.InputBatchAdminSession`		an `InputBatchAdminSession`
Errors	NOT_FOUND		no `System` found by the given `Id`
	NULL_ARGUMENT		`systemId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsInputBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInputBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getSettingBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk setting administration service.
Return	`osid.control.batch.SettingBatchAdminSession`		a `SettingBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSettingBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSettingBatchAdmin()` is `true.`
Method	getSettingBatchAdminSessionForSystem
Description	Gets the `OsidSession` associated with the bulk setting administration service for the given system.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System`
Return	`osid.control.batch.SettingBatchAdminSession`		a `SettingBatchAdminSession`
Errors	NOT_FOUND		no `System` found by the given `Id`
	NULL_ARGUMENT		`systemId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSettingBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSettingBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getSceneBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk scene administration service.
Return	`osid.control.batch.SceneBatchAdminSession`		a `SceneBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSceneBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSceneBatchAdmin()` is `true.`
Method	getSceneBatchAdminSessionForSystem
Description	Gets the `OsidSession` associated with the bulk scene administration service for the given system.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System`
Return	`osid.control.batch.SceneBatchAdminSession`		a `SceneBatchAdminSession`
Errors	NOT_FOUND		no `System` found by the given `Id`
	NULL_ARGUMENT		`systemId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsSceneBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSceneBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getTriggerBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk trigger administration service.
Return	`osid.control.batch.TriggerBatchAdminSession`		a `TriggerBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsTriggerBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTriggerBatchAdmin()` is `true.`
Method	getTriggerBatchAdminSessionForSystem
Description	Gets the `OsidSession` associated with the bulk trigger administration service for the given system.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System`
Return	`osid.control.batch.TriggerBatchAdminSession`		a `TriggerBatchAdminSession`
Errors	NOT_FOUND		no `System` found by the given `Id`
	NULL_ARGUMENT		`systemId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsTriggerBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTriggerBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getActionGroupBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk action group administration service.
Return	`osid.control.batch.ActionGroupBatchAdminSession`		an `ActionGroupBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsActionGroupBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActionGroupBatchAdmin()` is `true.`
Method	getActionGroupBatchAdminSessionForSystem
Description	Gets the `OsidSession` associated with the bulk action group administration service for the given system.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System`
Return	`osid.control.batch.ActionGroupBatchAdminSession`		an `ActionGroupBatchAdminSession`
Errors	NOT_FOUND		no `System` found by the given `Id`
	NULL_ARGUMENT		`systemId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsActionGroupBatchAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActionGroupBatchAdmin()` and `supportsVisibleFederation()` are `true`
Method	getSystemBatchAdminSession
Description	Gets the `OsidSession` associated with the bulk system administration service.
Return	`osid.control.batch.SystemBatchAdminSession`		a `SystemBatchAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsSystemBatchAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSystemBatchAdmin()` is `true.`