OSID - osid.mapping.LocationForm Service Interface Definition

Interface	osid.mapping.LocationForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidFederateableForm`
Implemented By	`osid.mapping.batch.LocationBatchForm`
Used By	`osid.mapping.LocationAdminSession`
Description	This is the form for creating and updating `Locations`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `LocationAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getSpatialUnitMetadata
Description	Gets the metadata for a spatial unit.
Return	`osid.Metadata`		metadata for the spatial unit
Compliance	`mandatory`		This method must be implemented.
Method	setSpatialUnit
Description	Sets the spatial unit.
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	the new spatial unit
Errors	INVALID_ARGUMENT		`spatialUnit` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`spatialUnit` is `null`
	UNSUPPORTED		`spatialUnit` type is not supported
Compliance	`mandatory`		This method must be implemented.
Method	clearSpatialUnit
Description	Removes the spatial unit.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLocationFormRecord
Description	Gets the `LocationFormRecord` corresponding to the given location record `Type`.
Parameters	`osid.type.Type`	`locationRecordType`	a location record type
Return	`osid.mapping.records.LocationFormRecord`		the location form record
Errors	NULL_ARGUMENT		`locationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(locationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.