OSID Logo
OSID Specifications
mapping path batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.batch.PathBatchAdminSession
Implementsosid.mapping.path.PathAdminSession
Description

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

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

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

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

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

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

MethodgetPathFormsForCreate
Description

Gets the path forms for creating a bunch of new paths.

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

Creates a new set of Paths. 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.path.batch.PathBatchFormListpathFormsthe path forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT pathForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPathFormsForUpdate
Description

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

Parametersosid.id.IdListpathIdsthe Ids of the Path
Returnosid.mapping.path.batch.PathBatchFormListthe path forms
ErrorsNOT_FOUNDa pathId is not found
NULL_ARGUMENT pathIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePaths
Description

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

Deletes all Paths in this Map .

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

Deletes paths for the given Ids.

Parametersosid.id.IdListpathIdsthe Ids of the paths to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT pathIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasPaths
Description

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