OSID Logo
OSID Specifications
provisioning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.batch.DistributorBatchAdminSession
Implementsosid.provisioning.DistributorAdminSession
Description

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

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

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

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

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

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

MethodgetDistributorFormsForCreate
Description

Gets the distributor forms for creating a bunch of new distributors.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]distributorRecordTypesarray of distributor record types to be included in each create operation or an empty list if none
Returnosid.provisioning.batch.DistributorBatchFormListthe distributor forms
ErrorsNULL_ARGUMENT distributorRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateDistributors
Description

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

Parametersosid.provisioning.batch.DistributorBatchFormListdistributorFormsthe distributor forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT distributorForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDistributorFormsForUpdate
Description

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

Parametersosid.id.IdListdistributorIdsthe Ids of the Distributor
Returnosid.provisioning.batch.DistributorBatchFormListthe distributor form
ErrorsNOT_FOUNDa distributorId is not found
NULL_ARGUMENT distributorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateDistributors
Description

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

Parametersosid.provisioning.batch.DistributorBatchFormListdistributorFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT distributorForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllDistributors
Description

Deletes all Distributors.

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

Deletes distributors for the given Ids.

Parametersosid.id.IdListdistributorIdsthe Ids of the distributors to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT distributorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasDistributors
Description

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