OSID Logo
OSID Specifications
mapping batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.batch.MapBatchAdminSession
Implementsosid.mapping.MapAdminSession
Description

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

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

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

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

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

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

MethodgetMapFormsForCreate
Description

Gets the map forms for creating a bunch of new maps.

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

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

Parametersosid.mapping.batch.MapBatchFormListmapFormsthe map forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT mapForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapFormsForUpdate
Description

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

Parametersosid.id.IdListmapIdsthe Ids of the Map
Returnosid.mapping.batch.MapBatchFormListthe map form
ErrorsNOT_FOUNDa mapId is not found
NULL_ARGUMENT mapIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateMaps
Description

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

Parametersosid.mapping.batch.MapBatchFormListmapFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT mapForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllMaps
Description

Deletes all Maps.

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

Deletes maps for the given Ids.

Parametersosid.id.IdListmapIdsthe Ids of the maps to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT mapIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasMaps
Description

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