org.osid.mapping.path.batch

Interface IntersectionBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, IntersectionAdminSession, OsidSession

public interface IntersectionBatchAdminSession
extends IntersectionAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasIntersections(AliasRequestList aliasRequests) Adds an Id to an Intersection for the purpose of creating compatibility.
CreateResponseList	createIntersections(IntersectionBatchFormList intersectionForms) Creates a new set of Intersections.
DeleteResponseList	deleteAllIntersections() Deletes all Intersections in this Map .
DeleteResponseList	deleteIntersections(IdList intersectionIds) Deletes intersections for the given Ids.
IntersectionBatchFormList	getIntersectionFormsForCreate(IntersectionPathList paths, Type[] intersectionRecordTypes) Gets the intersection forms for creating a bunch of new intersections.
IntersectionBatchFormList	getIntersectionFormsForUpdate(IdList intersectionIds) Gets the intersection forms for updating an existing set of intersections.
UpdateResponseList	updateIntersections(IntersectionBatchFormList intersectionForms) Updates existing intersections.

Methods inherited from interface org.osid.mapping.path.IntersectionAdminSession

addPathToIntersection, aliasIntersection, canCreateIntersections, canCreateIntersectionWithRecordTypes, canDeleteIntersections, canManageIntersectionAliases, canUpdateIntersection, canUpdateIntersections, createIntersection, deleteIntersection, getIntersectionFormForCreate, getIntersectionFormForUpdate, getMap, getMapId, removePathFromIntersection, updateIntersection

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getIntersectionFormsForCreate

IntersectionBatchFormList getIntersectionFormsForCreate(IntersectionPathList paths,
                                                      Type[] intersectionRecordTypes)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

paths - the list of paths for the intersections

intersectionRecordTypes - array of intersection record types to be included in each create operation or an empty list if none

Returns:

the intersection forms

Throws:

NotFoundException - a pathId is not found

NullArgumentException - paths or intersectionRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createIntersections

CreateResponseList createIntersections(IntersectionBatchFormList intersectionForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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 .

Parameters:

intersectionForms - the intersection forms

Returns:

the create responses

Throws:

NullArgumentException - intersectionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIntersectionFormsForUpdate

IntersectionBatchFormList getIntersectionFormsForUpdate(IdList intersectionIds)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

intersectionIds - the Ids of the Intersection

Returns:

the intersection forms

Throws:

NotFoundException - an intersectionId is not found

NullArgumentException - intersectionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateIntersections

UpdateResponseList updateIntersections(IntersectionBatchFormList intersectionForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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 .

Parameters:

intersectionForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - intersectionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllIntersections

DeleteResponseList deleteAllIntersections()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes all Intersections in this Map .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIntersections

DeleteResponseList deleteIntersections(IdList intersectionIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes intersections for the given Ids.

Parameters:

intersectionIds - the Ids of the intersections to delete

Returns:

the delete responses

Throws:

NullArgumentException - intersectionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasIntersections

AliasResponseList aliasIntersections(AliasRequestList aliasRequests)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.