Interface | osid.control.batch.DeviceBatchAdminSession | ||
---|---|---|---|
Implements | osid.control.DeviceAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getDeviceFormsForCreate | ||
Description |
Gets the device forms for creating a bunch of new devices. | ||
Parameters | cardinal | n | the number of forms to retrieve |
osid.type.Type[] | deviceRecordTypes | array of device record types to be included in each create operation or an empty list if none | |
Return | osid.control.batch.DeviceBatchFormList | the device forms | |
Errors | NULL_ARGUMENT | deviceRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createDevices | ||
Description |
Creates a new set of | ||
Parameters | osid.control.batch.DeviceBatchFormList | deviceForms | the device forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | deviceForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDeviceFormsForUpdate | ||
Description |
Gets the device forms for updating an existing set of devices. A new device form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | deviceIds | the Ids of the Device |
Return | osid.control.batch.DeviceBatchFormList | the device form | |
Errors | NOT_FOUND | a deviceId is not found | |
NULL_ARGUMENT | deviceIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateDevices | ||
Description |
Updates existing devices. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.control.batch.DeviceBatchFormList | deviceForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | deviceForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllDevices | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteDevices | ||
Description |
Deletes devices for the given | ||
Parameters | osid.id.IdList | deviceIds | the Ids of the devices to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | deviceIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasDevices | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |