OSID Logo
OSID Specifications
repository batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.batch.CompositionBatchAdminSession
Implementsosid.repository.CompositionAdminSession
Description

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

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

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

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

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

The delete operations delete Compositions in bulk. To unmap a Composition from the current Repository, the CompositionRepositoryAssignmentSession should be used. These delete operations attempt to remove the Composition itself thus removing it from all known Repository catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetCompositionFormsForCreate
Description

Gets the composition forms for creating a bunch of new compositions.

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

Creates a new set of Compositions. 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.CompositionBatchFormListcompositionFormsthe composition forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT compositionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCompositionFormsForUpdate
Description

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

Parametersosid.id.IdListcompositionIdsthe Ids of the Composition
Returnosid.repository.batch.CompositionBatchFormListthe composition form
ErrorsNOT_FOUNDa compositionId is not found
NULL_ARGUMENT compositionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCompositions
Description

Updates existing compositions. 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.CompositionBatchFormListcompositionFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT compositionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllCompositions
Description

Deletes all Compositions in this Repository .

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

Deletes compositions for the given Ids.

Parametersosid.id.IdListcompositionIdsthe Ids of the compositions to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT compositionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveCompositionsByDate
Description

Deletes compositions expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasCompositions
Description

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