OSID Logo
OSID Specifications
control batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.batch.ControllerBatchAdminSession
Implementsosid.control.ControllerAdminSession
Description

This session creates, updates, and deletes Controllers 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 Controller, a ControllerForm is requested using getControllerFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned ControllerForms 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 ControllerForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ControllerForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Controllers in bulk. To unmap a Controller from the current System, the ControllerSystemAssignmentSession should be used. These delete operations attempt to remove the Controller itself thus removing it from all known System catalogs. Bulk delete operations return the results in DeleteControllers.

MethodgetControllerFormsForCreate
Description

Gets the controller forms for creating a bunch of new controllers.

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

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

Parametersosid.control.batch.ControllerBatchFormListcontrollerFormsthe controller forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT controllerForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetControllerFormsForUpdate
Description

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

Parametersosid.id.IdListcontrollerIdsthe Ids of the Controller
Returnosid.control.batch.ControllerBatchFormListthe controller form
ErrorsNOT_FOUNDa controllerId is not found
NULL_ARGUMENT controllerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateControllers
Description

Updates existing controllers. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateController .

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

Deletes all Controllers in this System.

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

Deletes controllers for the given Ids.

Parametersosid.id.IdListcontrollerIdsthe Ids of the controllers to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT controllerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasControllers
Description

Adds an Id to a Controller for the purpose of creating compatibility. The primary Id of the Controller is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another controller, it is reassigned to the given controller 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.