Interface | osid.mapping.batch.MapBatchAdminSession | ||
---|---|---|---|
Implements | osid.mapping.MapAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getMapFormsForCreate | ||
Description |
Gets the map forms for creating a bunch of new maps. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | mapRecordTypes | array of map record types to be included in each create operation or an empty list if none | |
Return | osid.mapping.batch.MapBatchFormList | the map forms | |
Errors | NULL_ARGUMENT | mapRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createMaps | ||
Description |
Creates a new set of | ||
Parameters | osid.mapping.batch.MapBatchFormList | mapForms | the map forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | mapForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMapFormsForUpdate | ||
Description |
Gets the map forms for updating an existing set of maps. A new map form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | mapIds | the Ids of the Map |
Return | osid.mapping.batch.MapBatchFormList | the map form | |
Errors | NOT_FOUND | a mapId is not found | |
NULL_ARGUMENT | mapIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateMaps | ||
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 | ||
Parameters | osid.mapping.batch.MapBatchFormList | mapForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | mapForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllMaps | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteMaps | ||
Description |
Deletes maps for the given | ||
Parameters | osid.id.IdList | mapIds | the Ids of the maps to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | mapIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasMaps | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |