Interface | osid.mapping.path.SpeedZoneAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | getMapId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Map Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMap | ||
Description |
Gets the | ||
Return | osid.mapping.Map | the map | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateSpeedZones | ||
Description |
Tests if this user can create | ||
Return | boolean | false if SpeedZone creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateSpeedZoneWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | speedZoneRecordTypes | array of speed zone record types |
Return | boolean | true if SpeedZone creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | speedZoneRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZoneFormForCreate | ||
Description |
Gets the speed zone form for creating new speed zones. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | speedZoneRecordTypes | array of speed zone record types |
Return | osid.mapping.path.SpeedZoneForm | the speed zone form | |
Errors | NULL_ARGUMENT | speedZoneRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createSpeedZone | ||
Description |
Creates a new | ||
Parameters | osid.mapping.path.SpeedZoneForm | speedZoneForm | the form for this SpeedZone |
Return | osid.mapping.path.SpeedZone | the new SpeedZone | |
Errors | ILLEGAL_STATE | speedZoneForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | speedZoneForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | speedZoneForm did not originate from
getSpeedZoneFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateSpeedZones | ||
Description |
Tests if this user can update | ||
Return | boolean | false if SpeedZone modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZoneFormForUpdate | ||
Description |
Gets the speed zone form for updating an existing speed zone. A new speed zone form should be requested for each update transaction. | ||
Parameters | osid.id.Id | speedZoneId | the Id of the SpeedZone |
Return | osid.mapping.path.SpeedZoneForm | the speed zone form | |
Errors | NOT_FOUND | speedZoneId is not found | |
NULL_ARGUMENT | speedZoneId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateSpeedZone | ||
Description |
Updates an existing speed zone. | ||
Parameters | osid.mapping.path.SpeedZoneForm | speedZoneForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | speedZoneForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | speedZoneId or speed zoneForm is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | speedZoneForm did not originate from
getSpeedZoneFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteSpeedZone | ||
Description |
Tests if this user can delete a specified | ||
Parameters | osid.id.Id | speedZoneId | the Id of the SpeedZone |
Return | boolean | false if deletion of this SpeedZone is not
authorized, true otherwise | |
Errors | NULL_ARGUMENT | speedZoneId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | deleteSpeedZone | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | speedZoneId | the Id of the SpeedZone to remove |
Errors | NOT_FOUND | speedZoneId not found | |
NULL_ARGUMENT | speedZoneId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSpeedZoneAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if SpeedZone aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasSpeedZone | ||
Description |
Adds an | ||
Parameters | osid.id.Id | speedZoneId | the Id of a SpeedZone |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | speedZoneId not found | ||
NULL_ARGUMENT | speedZoneId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |