OSID Logo
OSID Specifications
offering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.batch.CanonicalUnitBatchAdminSession
Implementsosid.offering.CanonicalUnitAdminSession
Description

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

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

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

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

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

The delete operations delete CanonicalUnits in bulk. To unmap a CanonicalUnit from the current Catalogue, the CanonicalUnitCatalogueAssignmentSession should be used. These delete operations attempt to remove the CanonicalUnit itself thus removing it from all known Catalogue catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetCanonicalUnitFormsForCreate
Description

Gets the canonical unit forms for creating a bunch of new canonical units.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]canonicalUnitRecordTypesarray of canonical unit record types to be included in each create operation or an empty list if none
Returnosid.offering.batch.CanonicalUnitBatchFormListthe canonical unit forms
ErrorsNULL_ARGUMENT canonicalUnitRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateCanonicalUnits
Description

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

Parametersosid.offering.batch.CanonicalUnitBatchFormListcanonicalUnitFormsthe canonical unit forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT canonicalUnitForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitFormsForUpdate
Description

Gets the canonical unit forms for updating an existing set of canonicalUnits. A new canonical unit form should be requested for each update transaction.

Parametersosid.id.IdListcanonicalUnitIdsthe Ids of the CanonicalUnit
Returnosid.offering.batch.CanonicalUnitBatchFormListthe canonical unit form
ErrorsNOT_FOUNDa canonicalUnitId is not found
NULL_ARGUMENT canonicalUnitIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCanonicalUnits
Description

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

Parametersosid.offering.batch.CanonicalUnitBatchFormListcanonicalUnitFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT canonicalUnitForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllCanonicalUnits
Description

Deletes all CanonicalUnits in this Catalogue .

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

Deletes canonicalUnits for the given Ids.

Parametersosid.id.IdListcanonicalUnitIdsthe Ids of the canonical units to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT canonicalUnitIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasCanonicalUnits
Description

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