OSID - osid.mapping.MappingProfile Service Interface Definition

Interface	osid.mapping.MappingProfile
Implements	`osid.OsidProfile`
Description	The mapping profile describes the interoperability among mapping services.
Method	supportsVisibleFederation
Description	Tests if any map federation is exposed. Federation is exposed when a specific map may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of maps appears as a single map.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationLookup
Description	Tests if looking up locations is supported.
Return	`boolean`		`true` if location lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationQuery
Description	Tests if querying locations is supported.
Return	`boolean`		`true` if location query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationSearch
Description	Tests if searching locations is supported.
Return	`boolean`		`true` if location search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationAdmin
Description	Tests if location administrative service is supported.
Return	`boolean`		`true` if location administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationNotification
Description	Tests if a location notification service is supported.
Return	`boolean`		`true` if location notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationHierarchy
Description	Tests if a location hierarchy service is supported.
Return	`boolean`		`true` if location hierarchy is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationHierarchyDesign
Description	Tests if a location hierarchy design service is supported.
Return	`boolean`		`true` if location hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationMap
Description	Tests if a location map lookup service is supported.
Return	`boolean`		`true` if a location map lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationMapAssignment
Description	Tests if a location map assignment service is supported.
Return	`boolean`		`true` if a location to map assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationSmartMap
Description	Tests if a location smart map service is supported.
Return	`boolean`		`true` if a location smart map service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationAdjacency
Description	Tests if a location adjacency service is supported.
Return	`boolean`		`true` if a location adjacency service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationSpatial
Description	Tests if a location spatial service is supported.
Return	`boolean`		`true` if a location spatial service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceLocation
Description	Tests if a resource location service is supported.
Return	`boolean`		`true` if a resource location service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceLocationUpdate
Description	Tests if a resource location update service is supported.
Return	`boolean`		`true` if a resource location update service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceLocationNotification
Description	Tests if a resource location notification service is supported.
Return	`boolean`		`true` if a resource location notification service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourcePositionNotification
Description	Tests if a resource position notification service is supported.
Return	`boolean`		`true` if a resource position notification service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMyLocation
Description	Tests if a location service is supported for the current agent.
Return	`boolean`		`true` if my location is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMapLookup
Description	Tests if looking up maps is supported.
Return	`boolean`		`true` if map lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMapQuery
Description	Tests if querying maps is supported.
Return	`boolean`		`true` if a map query service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMapSearch
Description	Tests if searching maps is supported.
Return	`boolean`		`true` if map search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMapAdmin
Description	Tests if map administrative service is supported.
Return	`boolean`		`true` if map administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMapNotification
Description	Tests if a map notification service is supported.
Return	`boolean`		`true` if map notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMapHierarchy
Description	Tests for the availability of a map hierarchy traversal service.
Return	`boolean`		`true` if map hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsMapHierarchyDesign
Description	Tests for the availability of a map hierarchy design service.
Return	`boolean`		`true` if map hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMappingBatch
Description	Tests if the mapping batch service is supported.
Return	`boolean`		`true` if maping batch service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMappingPath
Description	Tests if the mapping path service is supported.
Return	`boolean`		`true` if maping path service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMappingRoute
Description	Tests if the mapping route service is supported.
Return	`boolean`		`true` if maping route service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLocationRecordTypes
Description	Gets the supported `Location` record types.
Return	`osid.type.TypeList`		a list containing the supported `Location` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationRecordType
Description	Tests if the given `Location` record type is supported.
Parameters	`osid.type.Type`	`locationRecordType`	a `Type` indicating a `Location` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`locationRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getLocationSearchRecordTypes
Description	Gets the supported `Location` search types.
Return	`osid.type.TypeList`		a list containing the supported `Location` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationSearchRecordType
Description	Tests if the given `Location` search type is supported.
Parameters	`osid.type.Type`	`locationSearchRecordType`	a `Type` indicating a `Location` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`locationSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getMapRecordTypes
Description	Gets the supported `Map` record types.
Return	`osid.type.TypeList`		a list containing the supported `Map` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsMapRecordType
Description	Tests if the given `Map` record type is supported.
Parameters	`osid.type.Type`	`mapRecordType`	a `Type` indicating a `Map` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`mapRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getMapSearchRecordTypes
Description	Gets the supported `Map` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Map` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsMapSearchRecordType
Description	Tests if the given `Map` search record type is supported.
Parameters	`osid.type.Type`	`mapSearchRecordType`	a `Type` indicating a `Map` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`mapSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResourceLocationRecordTypes
Description	Gets the supported `ResourceLocation` record types.
Return	`osid.type.TypeList`		a list containing the supported `ResourceLocation` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceLocationRecordType
Description	Tests if the given `ResourceLocationRecord` record type is supported.
Parameters	`osid.type.Type`	`resourceLocationRecordType`	a `Type` indicating a `ResourceLocation` type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`resourceLocationRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCoordinateTypes
Description	Gets the supported `Coordinate` types.
Return	`osid.type.TypeList`		a list containing the supported `Coordinate` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCoordinateType
Description	Tests if the given `Coordinate` type is supported.
Parameters	`osid.type.Type`	`coordinateType`	a `Type` indicating a `Coordinate` type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`coordinateType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getHeadingTypes
Description	Gets the supported `Heading` types.
Return	`osid.type.TypeList`		a list containing the supported `Heading` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsHeadingType
Description	Tests if the given `Heading` type is supported.
Parameters	`osid.type.Type`	`headingType`	a `Type` indicating a `Heading` type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`headingType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSpatialUnitRecordTypes
Description	Gets the supported `SpatialUnit` record types.
Return	`osid.type.TypeList`		a list containing the supported `SpatialUnit` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpatialUnitRecordType
Description	Tests if the given `SpatialUnit` record type is supported.
Parameters	`osid.type.Type`	`spatialUnitRecordType`	a `Type` indicating a `SpatialUnit` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`spatialUnitRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.