OSID Logo
OSID Specifications
mapping batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.batch.LocationBatchAdminSession
Implementsosid.mapping.LocationAdminSession
Description

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

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

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

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

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

The delete operations delete Locations in bulk. To unmap a Location from the current Map, the LocationMapAssignmentSession should be used. These delete operations attempt to remove the Location itself thus removing it from all known Map catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetLocationFormsForCreate
Description

Gets the location forms for creating a bunch of new locations.

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

Creates a new set of Locations. 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.LocationBatchFormListlocationFormsthe location forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT locationForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLocationFormsForUpdate
Description

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

Parametersosid.id.IdListlocationIdsthe Ids of the Location
Returnosid.mapping.batch.LocationBatchFormListthe location form
ErrorsNOT_FOUNDa locationId is not found
NULL_ARGUMENT locationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateLocations
Description

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

Deletes all Locations in this Map .

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

Deletes locations for the given Ids.

Parametersosid.id.IdListlocationIdsthe Ids of the locations to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT locationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasLocations
Description

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