org.osid.mapping.batch

Interface LocationBatchAdminSession

All Superinterfaces:

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

public interface LocationBatchAdminSession
extends LocationAdminSession

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

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

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

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

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

The delete operations delete Locations in bulk. To unmap a Location from the current Map, the LocationMapAssignmentSession should be used. These delete operations attempt to remove the Location 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	aliasLocations(AliasRequestList aliasRequests) Adds an Id to a Location for the purpose of creating compatibility.
CreateResponseList	createLocations(LocationBatchFormList locationForms) Creates a new set of Locations.
DeleteResponseList	deleteAllLocations() Deletes all Locations in this Map .
DeleteResponseList	deleteLocations(IdList locationIds) Deletes locations for the given Ids.
LocationBatchFormList	getLocationFormsForCreate(long number, Type[] locationRecordTypes) Gets the location forms for creating a bunch of new locations.
LocationBatchFormList	getLocationFormsForUpdate(IdList locationIds) Gets the location forms for updating an existing set of locations.
UpdateResponseList	updateLocations(LocationBatchFormList locationForms) Updates existing locations.

Methods inherited from interface org.osid.mapping.LocationAdminSession

aliasLocation, canCreateLocations, canCreateLocationWithRecordTypes, canDeleteLocations, canManageLocationAliases, canUpdateLocations, createLocation, deleteLocation, getLocationFormForCreate, getLocationFormForUpdate, getMap, getMapId, updateLocation

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

getLocationFormsForCreate

LocationBatchFormList getLocationFormsForCreate(long number,
                                              Type[] locationRecordTypes)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets the location forms for creating a bunch of new locations.

Parameters:

number - the number of forms to retrieve

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

Returns:

the location forms

Throws:

NullArgumentException - locationRecordTypes 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.

createLocations

CreateResponseList createLocations(LocationBatchFormList locationForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Creates a new set of Locations. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

locationForms - the location forms

Returns:

the create responses

Throws:

NullArgumentException - locationForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLocationFormsForUpdate

LocationBatchFormList getLocationFormsForUpdate(IdList locationIds)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

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

Parameters:

locationIds - the Ids of the Location

Returns:

the location form

Throws:

NotFoundException - a locationId is not found

NullArgumentException - locationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateLocations

UpdateResponseList updateLocations(LocationBatchFormList locationForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Updates existing locations. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

locationForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - locationForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllLocations

DeleteResponseList deleteAllLocations()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes all Locations in this Map .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteLocations

DeleteResponseList deleteLocations(IdList locationIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes locations for the given Ids.

Parameters:

locationIds - the Ids of the locations to delete

Returns:

the delete responses

Throws:

NullArgumentException - locationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasLocations

AliasResponseList aliasLocations(AliasRequestList aliasRequests)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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