OSID - osid.mapping.ResourceLocation Service Interface Definition

Interface	osid.mapping.ResourceLocation
Implements	`osid.OsidCompendium`
Used By	`osid.mapping.ResourceLocationList`
Used By	`osid.mapping.ResourceLocationSession`
Description	This interface defines a resource at a location.
Method	getResourceId
Description	Gets the `Id` of the resource on the route.
Return	`osid.id.Id`		the resource `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getResource
Description	Gets the resource on the route.
Return	`osid.resource.Resource`		the resource
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasLocation
Description	Tests if this resource has a known location.
Return	`boolean`		`true` if a location is known, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLocationId
Description	Gets the location `Id` of the resource.
Return	`osid.id.Id`		the location `Id`
Errors	ILLEGAL_STATE		`hasLocation()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getLocation
Description	Gets the location of the resource.
Return	`osid.mapping.Location`		the location
Errors	ILLEGAL_STATE		`hasLocation()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasCoordinate
Description	Tests if this resource has a known coordinate.
Return	`boolean`		`true` if a coordinate is known, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCoordinate
Description	Gets the coordinate of the resource.
Return	`osid.mapping.Coordinate`		the coordinate of the resource
Errors	ILLEGAL_STATE		`hasCoordinate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getResourceLocationRecord
Description	Gets the map record corresponding to the given `ResourceLocation` record `Type`. This method is used to retrieve an object implementing the requested record. The `resourceLocationRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(resourceLocationRecordType)` is `true`.
Parameters	`osid.type.Type`	`resourceLocationRecordType`	the type of resource location record to retrieve
Return	`osid.mapping.records.ResourceLocationRecord`		the resource location record
Errors	NULL_ARGUMENT		`resourceLocationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(resourceLocationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.