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

Interface	osid.mapping.path.SpeedZoneForm
Implements	`osid.OsidRuleForm`
Description	This is the form for creating and updating `SpeedZones.` Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `SpeedZoneAdminSession.` For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getStartingCoordinateMetadata
Description	Gets the metadata for a starting coordinate.
Return	`osid.Metadata`		metadata for the starting coordinate
Compliance	`mandatory`		This method must be implemented.
Method	setStartingCoordinate
Description	Sets the starting coordinate.
Parameters	`osid.mapping.Coordinate`	`coordinate`	the new starting coordinate
Errors	INVALID_ARGUMENT		`coordinate` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`coordinate` is `null`
	UNSUPPORTED		`coordinate` type is not supported
Compliance	`mandatory`		This method must be implemented.
Method	clearStartingCoordinate
Description	Removes the starting coordinate.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEndingCoordinateMetadata
Description	Gets the metadata for a ending coordinate.
Return	`osid.Metadata`		metadata for the ending coordinate
Compliance	`mandatory`		This method must be implemented.
Method	setEndingCoordinate
Description	Sets the ending coordinate.
Parameters	`osid.mapping.Coordinate`	`coordinate`	the new ending coordinate
Errors	INVALID_ARGUMENT		`coordinate` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`coordinate` is `null`
	UNSUPPORTED		`coordinate` type is not supported
Compliance	`mandatory`		This method must be implemented.
Method	clearEndingCoordinate
Description	Removes the ending coordinate.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedLimitMetadata
Description	Gets the metadata for a speed limit.
Return	`osid.Metadata`		metadata for the speed limit
Compliance	`mandatory`		This method must be implemented.
Method	setSpeedLimit
Description	Sets the speed limit.
Parameters	`osid.mapping.Speed`	`speed`	the new speed limit
Errors	INVALID_ARGUMENT		`speed` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`speed` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSpeedLimit
Description	Removes the speed limit.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneFormRecord
Description	Gets the `SpeedZoneFormRecord` corresponding to the given speed zone record `Type.`
Parameters	`osid.type.Type`	`speedZoneRecordType`	a speed zone record type
Return	`osid.mapping.path.records.SpeedZoneFormRecord`		the speed zone form record
Errors	NULL_ARGUMENT		`speedZoneRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(speedZoneRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.