OSID - osid.mapping.path.SpeedZoneAdminSession Service Interface Definition

Interface	osid.mapping.path.SpeedZoneAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `SpeedZones.` 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 `SpeedZoneForm,` a `SpeedZoneForm` is requested using `getSpeedZoneFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `SpeedZoneForm` 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 the `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. For updates, `SpeedZoneForms` are requested to the `SpeedZone` `Id` that is to be updated using `getSpeedZoneFormForUpdate().` 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. The delete operations delete `SpeedZones.` 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. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getMapId
Description	Gets the `Map` `Id` associated with this session.
Return	`osid.id.Id`		the `Map Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMap
Description	Gets the `Map` associated with this session.
Return	`osid.mapping.Map`		the map
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSpeedZones
Description	Tests if this user can create `SpeedZones.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `SpeedZone` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
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 `SpeedZone` using the desired record types. While `MappingPathManager.getSpeedZoneRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `SpeedZone.` Providing an empty array tests if a `SpeedZone` can be created with no records.
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 `SpeedZone.`
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 `SpeedZones.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `SpeedZone` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
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 `SpeedZone.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the `SpeedZone` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer an delete operation to an unauthorized user.
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 `speedZoneId` is not found, then it is acceptable to return false to indicate the lack of an delete available.
Method	deleteSpeedZone
Description	Deletes a `SpeedZone.`
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 `Id` aliases for `SpeedZones.` A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `SpeedZone` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasSpeedZone
Description	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` performs as 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	`osid.id.Id`	`speedZoneId`	the `Id` of a `SpeedZone`
Parameters	`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.