OSID Logo
OSID Specifications
control batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.batch.DeviceBatchAdminSession
Implementsosid.control.DeviceAdminSession
Description

This session creates, updates, and deletes Devices in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Device, a DeviceForm is requested using getDeviceFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned DeviceForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a DeviceForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each DeviceForm corresponds to an attempted transaction.

The DeviceForms returned from getDeviceFormsForCreate() may be linked to the originating request through the peer Ids of the DeviceForm. In the case where there may be duplicates, any DeviceForm of the same peer Ids may be used for a create operation.

Once a batch of DeviceForm are submitted for create, a CreateDevice is returned for each DeviceForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createDevices(), errors specific to an individual DeviceForm are indicated in the corresponding CreateDevice. CreateDevices may be linked to the originating DeviceForm through the DeviceForm Id .

For updates, DeviceForms are requested to the Device Id that is to be updated using getDeviceFormsForUpdate() where the reference Id in the DeviceForm may be used to link the request. Similarly, the DeviceForm has metadata about the data that can be updated and it can perform validation before submitting the update. The DeviceForm can only be used once for a successful update and cannot be reused.

Once a batch of DeviceForms are submitted for update, an UpdateDevice is returned for each DeviceForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateDevices(), errors specific to an individual DeviceForm are indicated in the corresponding UpdateDevice. UpdateDevices may be linked to the originating DeviceForm through the DeviceForm Id.

The delete operations delete Devices in bulk. To unmap a Device from the current System, the DeviceSystemAssignmentSession should be used. These delete operations attempt to remove the Device itself thus removing it from all known System catalogs. Bulk delete operations return the results in DeleteDevices.

MethodgetDeviceFormsForCreate
Description

Gets the device forms for creating a bunch of new devices.

Parameterscardinalnthe number of forms to retrieve
osid.type.Type[]deviceRecordTypesarray of device record types to be included in each create operation or an empty list if none
Returnosid.control.batch.DeviceBatchFormListthe device forms
ErrorsNULL_ARGUMENT deviceRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateDevices
Description

Creates a new set of Devices. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateDevice .

Parametersosid.control.batch.DeviceBatchFormListdeviceFormsthe device forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT deviceForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDeviceFormsForUpdate
Description

Gets the device forms for updating an existing set of devices. A new device form should be requested for each update transaction.

Parametersosid.id.IdListdeviceIdsthe Ids of the Device
Returnosid.control.batch.DeviceBatchFormListthe device form
ErrorsNOT_FOUNDa deviceId is not found
NULL_ARGUMENT deviceIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateDevices
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 BatchCreateDevice .

Parametersosid.control.batch.DeviceBatchFormListdeviceFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT deviceForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllDevices
Description

Deletes all Devices in this System.

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteDevices
Description

Deletes devices for the given Ids.

Parametersosid.id.IdListdeviceIdsthe Ids of the devices to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT deviceIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasDevices
Description

Adds an Id to a Device for the purpose of creating compatibility. The primary Id of the Device is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another device, it is reassigned to the given device Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.