org.osid.mapping.batch

Interface MapBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, MapAdminSession, OsidSession

public interface MapBatchAdminSession
extends MapAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasMaps(AliasRequestList aliasRequests) Adds an Id to a Map for the purpose of creating compatibility.
CreateResponseList	createMaps(MapBatchFormList mapForms) Creates a new set of Maps.
DeleteResponseList	deleteAllMaps() Deletes all Maps.
DeleteResponseList	deleteMaps(IdList mapIds) Deletes maps for the given Ids.
MapBatchFormList	getMapFormsForCreate(long number, Type[] mapRecordTypes) Gets the map forms for creating a bunch of new maps.
MapBatchFormList	getMapFormsForUpdate(IdList mapIds) Gets the map forms for updating an existing set of maps.
UpdateResponseList	updateMaps(MapBatchFormList mapForms) Updates existing maps.

Methods inherited from interface org.osid.mapping.MapAdminSession

aliasMap, canCreateMaps, canCreateMapWithRecordTypes, canDeleteMaps, canManageMapAliases, canUpdateMaps, createMap, deleteMap, getMapFormForCreate, getMapFormForUpdate, updateMap

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getMapFormsForCreate

MapBatchFormList getMapFormsForCreate(long number,
                                    Type[] mapRecordTypes)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

mapRecordTypes - array of map record types to be included in each create operation or an empty list if none

Returns:

the map forms

Throws:

NullArgumentException - mapRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createMaps

CreateResponseList createMaps(MapBatchFormList mapForms)
                              throws OperationFailedException,
                                     PermissionDeniedException

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 .

Parameters:

mapForms - the map forms

Returns:

the create responses

Throws:

NullArgumentException - mapForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMapFormsForUpdate

MapBatchFormList getMapFormsForUpdate(IdList mapIds)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

mapIds - the Ids of the Map

Returns:

the map form

Throws:

NotFoundException - a mapId is not found

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateMaps

UpdateResponseList updateMaps(MapBatchFormList mapForms)
                              throws OperationFailedException,
                                     PermissionDeniedException

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 .

Parameters:

mapForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - mapForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllMaps

DeleteResponseList deleteAllMaps()
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes all Maps.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteMaps

DeleteResponseList deleteMaps(IdList mapIds)
                              throws OperationFailedException,
                                     PermissionDeniedException

Deletes maps for the given Ids.

Parameters:

mapIds - the Ids of the maps to delete

Returns:

the delete responses

Throws:

NullArgumentException - mapIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasMaps

AliasResponseList aliasMaps(AliasRequestList aliasRequests)
                            throws OperationFailedException,
                                   PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.