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.
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.
|
aliasMap, canCreateMaps, canCreateMapWithRecordTypes, canDeleteMaps, canManageMapAliases, canUpdateMaps, createMap, deleteMap, getMapFormForCreate, getMapFormForUpdate, updateMap
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
MapBatchFormList getMapFormsForCreate(long number, Type[] mapRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievemapRecordTypes
- array of map record types to be included in
each create operation or an empty list if noneNullArgumentException
- mapRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createMaps(MapBatchFormList mapForms) throws OperationFailedException, PermissionDeniedException
Maps.
This method returns an error
if the entire operation fails. Otherwise, the status of an individual
create operation is indicated in the BatchCreateResponse
.mapForms
- the map formsNullArgumentException
- mapForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. MapBatchFormList getMapFormsForUpdate(IdList mapIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
mapIds
- the Ids
of the Map
NotFoundException
- a mapId
is not foundNullArgumentException
- mapIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateMaps(MapBatchFormList mapForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.mapForms
- the form containing the elements to be updatedNullArgumentException
- mapForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllMaps() throws OperationFailedException, PermissionDeniedException
Maps.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteMaps(IdList mapIds) throws OperationFailedException, PermissionDeniedException
Ids.
mapIds
- the Ids
of the maps to deleteNullArgumentException
- mapIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasMaps(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.