org.osid.mapping.path.batch

Interface SpeedZoneBatchAdminSession

All Superinterfaces:

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

public interface SpeedZoneBatchAdminSession
extends SpeedZoneAdminSession

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

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

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

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

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

The delete operations delete SpeedZones in bulk. To unmap a SpeedZone from the current Map, the SpeedZoneMapAssignmentSession should be used. These delete operations attempt to remove the SpeedZone 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	aliasSpeedZones(AliasRequestList aliasRequests) Adds an Id to a SpeedZone for the purpose of creating compatibility.
CreateResponseList	createSpeedZones(SpeedZoneBatchFormList speedZoneForms) Creates a new set of SpeedZones.
DeleteResponseList	deleteAllSpeedZones() Deletes all SpeedZones in this Map .
DeleteResponseList	deleteSpeedZones(IdList speedZoneIds) Deletes speed zones for the given Ids.
DeleteResponseList	deleteSpeedZonesOnPath(Id pathId) Deletes all speed zones on a path.
SpeedZoneBatchFormList	getSpeedZoneFormsForCreate(long number, Type[] speedZoneRecordTypes) Gets the speed zone forms for creating a bunch of new speed zones.
SpeedZoneBatchFormList	getSpeedZoneFormsForUpdate(IdList speedZoneIds) Gets the speed zone forms for updating an existing set of speed zones.
UpdateResponseList	updateSpeedZones(SpeedZoneBatchFormList speedZoneForms) Updates existing speed zones.

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

aliasSpeedZone, canCreateSpeedZones, canCreateSpeedZoneWithRecordTypes, canDeleteSpeedZone, canManageSpeedZoneAliases, canUpdateSpeedZones, createSpeedZone, deleteSpeedZone, getMap, getMapId, getSpeedZoneFormForCreate, getSpeedZoneFormForUpdate, updateSpeedZone

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

getSpeedZoneFormsForCreate

SpeedZoneBatchFormList getSpeedZoneFormsForCreate(long number,
                                                Type[] speedZoneRecordTypes)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Gets the speed zone forms for creating a bunch of new speed zones.

Parameters:

number - the numebr of forms to retrieve

speedZoneRecordTypes - array of speed zone record types to be included in each create operation or an empty list if none

Returns:

the speed zone forms

Throws:

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

createSpeedZones

CreateResponseList createSpeedZones(SpeedZoneBatchFormList speedZoneForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

speedZoneForms - the speed zone forms

Returns:

the create responses

Throws:

NullArgumentException - speedZoneForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSpeedZoneFormsForUpdate

SpeedZoneBatchFormList getSpeedZoneFormsForUpdate(IdList speedZoneIds)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Gets the speed zone forms for updating an existing set of speed zones. A new speed zone form should be requested for each update transaction.

Parameters:

speedZoneIds - the Ids of the SpeedZone

Returns:

the speed zone forms

Throws:

NotFoundException - a speedZoneId is not found

NullArgumentException - speedZoneIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateSpeedZones

UpdateResponseList updateSpeedZones(SpeedZoneBatchFormList speedZoneForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

speedZoneForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - speedZoneForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllSpeedZones

DeleteResponseList deleteAllSpeedZones()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes all SpeedZones in this Map .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSpeedZones

DeleteResponseList deleteSpeedZones(IdList speedZoneIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes speed zones for the given Ids.

Parameters:

speedZoneIds - the Ids of the speed zones to delete

Returns:

the delete responses

Throws:

NullArgumentException - speedZoneIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSpeedZonesOnPath

DeleteResponseList deleteSpeedZonesOnPath(Id pathId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes all speed zones on a path.

Parameters:

pathId - an Id of a path

Returns:

the delete responses

Throws:

NullArgumentException - pathId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasSpeedZones

AliasResponseList aliasSpeedZones(AliasRequestList aliasRequests)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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