OSID - osid.mapping.Location Service Interface Definition

Interface	osid.mapping.Location
Implements	`osid.OsidObject`
Implements	`osid.Federateable`
Used By	`osid.calendaring.Event`
	`osid.calendaring.MeetingTime`
	`osid.calendaring.OffsetEvent`
	`osid.calendaring.Schedule`
	`osid.inventory.Item`
	`osid.mapping.LocationAdminSession`
	`osid.mapping.LocationList`
	`osid.mapping.LocationLookupSession`
	`osid.mapping.LocationNode`
	`osid.mapping.LocationSpatialSession`
	show 3 more…
`osid.mapping.MyLocationSession`
`osid.mapping.ResourceLocation`
`osid.mapping.route.Route`
Description	A `Location` represents a location in a `Map`.
Method	hasSpatialUnit
Description	Tests if a spatial unit is available for this location.
Return	`boolean`		`true` if a spatial unit is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSpatialUnit
Description	Gets the spatial unit corresponding to this location.
Return	`osid.mapping.SpatialUnit`		the spatial unit for this location
Errors	ILLEGAL_STATE		`hasSpatialUnit()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getLocationRecord
Description	Gets the location record corresponding to the given `Location` record `Type`.This method is used to retrieve an object implementing the requested record. The `locationRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(locationRecordType)` is `true`.
Parameters	`osid.type.Type`	`locationRecordType`	the type of location record to retrieve
Return	`osid.mapping.records.LocationRecord`		the location 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.