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

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

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

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

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

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

The delete operations delete Obstacles in bulk. To unmap an Obstacle from the current Map, the ObstacleMapAssignmentSession should be used. These delete operations attempt to remove the Obstacle itself thus removing it from all known Map catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetObstacleFormsForCreate
Description

Gets the obstacle forms for creating a bunch of new obstacles. A form is returned for each supplied path.

Parametersosid.id.IdListpathIdsa list of paths
osid.type.Type[]obstacleRecordTypesarray of obstacle record types to be included in each create operation or an empty list if none
Returnosid.mapping.path.batch.ObstacleBatchFormListthe obstacle forms
ErrorsNOT_FOUNDa pathId is not found
NULL_ARGUMENT pathIds or obstacleRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateObstacles
Description

Creates a new set of Obstacles. 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.ObstacleBatchFormListobstacleFormsthe obstacle forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT obstacleForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObstacleFormsForUpdate
Description

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

Parametersosid.id.IdListobstacleIdsthe Ids of the Obstacle
Returnosid.mapping.path.batch.ObstacleBatchFormListthe obstacle forms
ErrorsNOT_FOUNDan obstacleId is not found
NULL_ARGUMENT obstacleIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateObstacles
Description

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

Deletes all Obstacles in this Map .

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

Deletes obstacles for the given Ids.

Parametersosid.id.IdListobstacleIdsthe Ids of the obstacles to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT obstacleIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteObstaclesForPath
Description

Deletes obstacles for the given path.

Parametersosid.id.IdListpathIdan Id of a path
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT pathId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasObstacles
Description

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