OSID Logo
OSID Specifications
repository batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.batch.RepositoryBatchAdminSession
Implementsosid.repository.RepositoryAdminSession
Description

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.

MethodgetRepositoryFormsForCreate
Description

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

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

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 .

Parametersosid.repository.batch.RepositoryBatchFormListrepositoryFormsthe repository forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT repositoryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRepositoryFormsForUpdate
Description

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

Parametersosid.id.IdListrepositoryIdsthe Ids of the Repository
Returnosid.repository.batch.RepositoryBatchFormListthe repository form
ErrorsNOT_FOUNDan repositoryId is not found
NULL_ARGUMENT repositoryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRepositories
Description

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 .

Parametersosid.repository.batch.RepositoryBatchFormListrepositoryFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT repositoryForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllRepositories
Description

Deletes all Repositories.

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

Deletes repositories for the given Ids.

Parametersosid.id.IdListrepositoryIdsthe Ids of the repositories to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT repositoryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasRepositories
Description

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.

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.