OSID Logo
OSID Specifications
offering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.batch.CatalogueBatchAdminSession
Implementsosid.offering.CatalogueAdminSession
Description

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

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

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

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

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

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

MethodgetCatalogueFormsForCreate
Description

Gets the catalogue forms for creating a bunch of new catalogues.

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

Creates a new set of Catalogues. 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.CatalogueBatchFormListcatalogueFormsthe catalogue forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT catalogueForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCatalogueFormsForUpdate
Description

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

Parametersosid.id.IdListcatalogueIdsthe Ids of the Catalogue
Returnosid.offering.batch.CatalogueBatchFormListthe catalogue form
ErrorsNOT_FOUNDa catalogueId is not found
NULL_ARGUMENT catalogueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCatalogues
Description

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

Deletes all Catalogues in this Calendar .

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

Deletes catalogues for the given Ids.

Parametersosid.id.IdListcatalogueIdsthe Ids of the catalogues to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT catalogueIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasCatalogues
Description

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