OSID Logo
OSID Specifications
installation batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.batch.DepotBatchAdminSession
Implementsosid.installation.DepotAdminSession
Description

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

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

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

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

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

The delete operations delete Depots in bulk. Bulk delete operations return the results in DeleteResponses.

MethodgetDepotFormsForCreate
Description

Gets the depot forms for creating a bunch of new depots.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]depotRecordTypesarray of depot record types to be included in each create operation or an empty list if none
Returnosid.installation.batch.DepotBatchFormListthe depot forms
ErrorsNULL_ARGUMENT depotRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateDepots
Description

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

Parametersosid.installation.batch.DepotBatchFormListdepotFormsthe depot forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT depotForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDepotFormsForUpdate
Description

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

Parametersosid.id.IdListdepotIdsthe Ids of the Depot
Returnosid.installation.batch.DepotBatchFormListthe depot form
ErrorsNOT_FOUNDan depotId is not found
NULL_ARGUMENT depotIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateDepots
Description

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

Parametersosid.installation.batch.DepotBatchFormListdepotFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT depotForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllDepots
Description

Deletes all Depots.

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

Deletes depots for the given Ids.

Parametersosid.id.IdListdepotIdsthe Ids of the depots to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT depotIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasDepots
Description

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