Interface | osid.mapping.path.batch.SpeedZoneBatchAdminSession | ||
---|---|---|---|
Implements | osid.mapping.path.SpeedZoneAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getSpeedZoneFormsForCreate | ||
Description |
Gets the speed zone forms for creating a bunch of new speed zones. | ||
Parameters | cardinal | number | the numebr of forms to retrieve |
osid.type.Type[] | speedZoneRecordTypes | array of speed zone record types to be included in each create operation or an empty list if none | |
Return | osid.mapping.path.batch.SpeedZoneBatchFormList | the speed zone forms | |
Errors | NULL_ARGUMENT | speedZoneRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createSpeedZones | ||
Description |
Creates a new set of | ||
Parameters | osid.mapping.path.batch.SpeedZoneBatchFormList | speedZoneForms | the speed zone forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | speedZoneForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZoneFormsForUpdate | ||
Description |
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 | osid.id.IdList | speedZoneIds | the Ids of the SpeedZone |
Return | osid.mapping.path.batch.SpeedZoneBatchFormList | the speed zone forms | |
Errors | NOT_FOUND | a speedZoneId is not found | |
NULL_ARGUMENT | speedZoneIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateSpeedZones | ||
Description |
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
| ||
Parameters | osid.mapping.path.batch.SpeedZoneBatchFormList | speedZoneForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | speedZoneForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllSpeedZones | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteSpeedZones | ||
Description |
Deletes speed zones for the given | ||
Parameters | osid.id.IdList | speedZoneIds | the Ids of the speed zones to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | speedZoneIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteSpeedZonesOnPath | ||
Description |
Deletes all speed zones on a path. | ||
Parameters | osid.id.Id | pathId | an Id of a path |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | pathId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasSpeedZones | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |