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

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

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

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

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

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

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

MethodgetIntersectionFormsForCreate
Description

Gets the intersection forms for creating a bunch of new intersections.

Parametersosid.mapping.path.batch.IntersectionPathListpathsthe list of paths for the intersections
osid.type.Type[]intersectionRecordTypesarray of intersection record types to be included in each create operation or an empty list if none
Returnosid.mapping.path.batch.IntersectionBatchFormListthe intersection forms
ErrorsNOT_FOUNDa pathId is not found
NULL_ARGUMENT paths or intersectionRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateIntersections
Description

Creates a new set of Intersections. 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.IntersectionBatchFormListintersectionFormsthe intersection forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT intersectionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionFormsForUpdate
Description

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

Parametersosid.id.IdListintersectionIdsthe Ids of the Intersection
Returnosid.mapping.path.batch.IntersectionBatchFormListthe intersection forms
ErrorsNOT_FOUNDan intersectionId is not found
NULL_ARGUMENT intersectionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateIntersections
Description

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

Deletes all Intersections in this Map .

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

Deletes intersections for the given Ids.

Parametersosid.id.IdListintersectionIdsthe Ids of the intersections to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT intersectionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasIntersections
Description

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