org.osid.provisioning.batch

Interface DistributorBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, DistributorAdminSession, OsidSession

public interface DistributorBatchAdminSession
extends DistributorAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasDistributors(AliasRequestList aliasRequests) Adds an Id to a Distributor for the purpose of creating compatibility.
CreateResponseList	createDistributors(DistributorBatchFormList distributorForms) Creates a new set of Distributors.
DeleteResponseList	deleteAllDistributors() Deletes all Distributors.
DeleteResponseList	deleteDistributors(IdList distributorIds) Deletes distributors for the given Ids.
DistributorBatchFormList	getDistributorFormsForCreate(long number, Type[] distributorRecordTypes) Gets the distributor forms for creating a bunch of new distributors.
DistributorBatchFormList	getDistributorFormsForUpdate(IdList distributorIds) Gets the distributor forms for updating an existing set of distributors.
UpdateResponseList	updateDistributors(DistributorBatchFormList distributorForms) Updates existing distributors.

Methods inherited from interface org.osid.provisioning.DistributorAdminSession

aliasDistributor, canCreateDistributors, canCreateDistributorWithRecordTypes, canDeleteDistributors, canManageDistributorAliases, canUpdateDistributors, createDistributor, deleteDistributor, getDistributorFormForCreate, getDistributorFormForUpdate, updateDistributor

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getDistributorFormsForCreate

DistributorBatchFormList getDistributorFormsForCreate(long number,
                                                    Type[] distributorRecordTypes)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

distributorRecordTypes - array of distributor record types to be included in each create operation or an empty list if none

Returns:

the distributor forms

Throws:

NullArgumentException - distributorRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createDistributors

CreateResponseList createDistributors(DistributorBatchFormList distributorForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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 .

Parameters:

distributorForms - the distributor forms

Returns:

the create responses

Throws:

NullArgumentException - distributorForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorFormsForUpdate

DistributorBatchFormList getDistributorFormsForUpdate(IdList distributorIds)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

distributorIds - the Ids of the Distributor

Returns:

the distributor form

Throws:

NotFoundException - a distributorId is not found

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateDistributors

UpdateResponseList updateDistributors(DistributorBatchFormList distributorForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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 .

Parameters:

distributorForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - distributorForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllDistributors

DeleteResponseList deleteAllDistributors()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes all Distributors.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteDistributors

DeleteResponseList deleteDistributors(IdList distributorIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes distributors for the given Ids.

Parameters:

distributorIds - the Ids of the distributors to delete

Returns:

the delete responses

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasDistributors

AliasResponseList aliasDistributors(AliasRequestList aliasRequests)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.