org.osid.repository.batch

Interface RepositoryBatchAdminSession

All Superinterfaces:

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

public interface RepositoryBatchAdminSession
extends RepositoryAdminSession

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

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

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

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

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

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

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasRepositories(AliasRequestList aliasRequests) Adds an Id to an Repository for the purpose of creating compatibility.
CreateResponseList	createRepositories(RepositoryBatchFormList repositoryForms) Creates a new set of Repositories.
DeleteResponseList	deleteAllRepositories() Deletes all Repositories.
DeleteResponseList	deleteRepositories(IdList repositoryIds) Deletes repositories for the given Ids.
RepositoryBatchFormList	getRepositoryFormsForCreate(long number, Type[] repositoryRecordTypes) Gets the repository forms for creating a bunch of new repositories.
RepositoryBatchFormList	getRepositoryFormsForUpdate(IdList repositoryIds) Gets the repository forms for updating an existing set of repositories.
UpdateResponseList	updateRepositories(RepositoryBatchFormList repositoryForms) Updates existing repositories.

Methods inherited from interface org.osid.repository.RepositoryAdminSession

aliasRepository, canCreateRepositories, canCreateRepositoryWithRecordTypes, canDeleteRepositories, canManageRepositoryAliases, canUpdateRepositories, createRepository, deleteRepository, getRepositoryFormForCreate, getRepositoryFormForUpdate, updateRepository

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

getRepositoryFormsForCreate

RepositoryBatchFormList getRepositoryFormsForCreate(long number,
                                                  Type[] repositoryRecordTypes)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets the repository forms for creating a bunch of new repositories.

Parameters:

number - the number of forms to retrieve

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

Returns:

the repository forms

Throws:

NullArgumentException - repositoryRecordTypes 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.

createRepositories

CreateResponseList createRepositories(RepositoryBatchFormList repositoryForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

repositoryForms - the repository forms

Returns:

the create responses

Throws:

NullArgumentException - repositoryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRepositoryFormsForUpdate

RepositoryBatchFormList getRepositoryFormsForUpdate(IdList repositoryIds)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

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

Parameters:

repositoryIds - the Ids of the Repository

Returns:

the repository form

Throws:

NotFoundException - an repositoryId is not found

NullArgumentException - repositoryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateRepositories

UpdateResponseList updateRepositories(RepositoryBatchFormList repositoryForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

repositoryForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - repositoryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllRepositories

DeleteResponseList deleteAllRepositories()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes all Repositories.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRepositories

DeleteResponseList deleteRepositories(IdList repositoryIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes repositories for the given Ids.

Parameters:

repositoryIds - the Ids of the repositories to delete

Returns:

the delete responses

Throws:

NullArgumentException - repositoryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasRepositories

AliasResponseList aliasRepositories(AliasRequestList aliasRequests)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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