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

Interface	osid.mapping.path.MappingPathProfile
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	supportsPathLookup
Description	Tests if looking up paths is supported.
Return	`boolean`		`true` if path lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathQuery
Description	Tests if querying paths is supported.
Return	`boolean`		`true` if path query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathSearch
Description	Tests if searching paths is supported.
Return	`boolean`		`true` if path search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathAdmin
Description	Tests if path administrative service is supported.
Return	`boolean`		`true` if path administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathNotification
Description	Tests if a path notification service is supported.
Return	`boolean`		`true` if path notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathMap
Description	Tests if a path map lookup service is supported.
Return	`boolean`		`true` if a path map lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathMapAssignment
Description	Tests if a path map service is supported.
Return	`boolean`		`true` if path to map assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathSmartMap
Description	Tests if a path smart map lookup service is supported.
Return	`boolean`		`true` if a path smart map service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathSpatial
Description	Tests if a path spatial lookup service is supported.
Return	`boolean`		`true` if a path spatial service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathSpatialDesign
Description	Tests if a path spatial design service is supported.
Return	`boolean`		`true` if a path spatial design service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathTravel
Description	Tests if a path travel service is supported.
Return	`boolean`		`true` if a path travel service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourcePathNotification
Description	Tests if a resource path notification service is supported.
Return	`boolean`		`true` if a resource path notification service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceVelocity
Description	Tests if a resource velocity service is supported.
Return	`boolean`		`true` if a resource velocity service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceVelocityUpdate
Description	Tests if a resource velocity update service is supported.
Return	`boolean`		`true` if a resource velocity update service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceVelocityNotification
Description	Tests if a resource velocity notification service is supported.
Return	`boolean`		`true` if a resource velocity notification service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMyPath
Description	Tests if a my path service is supported.
Return	`boolean`		`true` if a my path service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIntersectionLookup
Description	Tests if an intersection lookup service is supported.
Return	`boolean`		`true` if an intersection lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIntersectionQuery
Description	Tests if querying intersections is supported.
Return	`boolean`		`true` if intersection query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIntersectionSearch
Description	Tests if searching intersections is supported.
Return	`boolean`		`true` if intersection search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIntersectionAdmin
Description	Tests if an intersection administrative service is supported.
Return	`boolean`		`true` if an intersection administrative service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIntersectionNotification
Description	Tests if an intersection notification service is supported.
Return	`boolean`		`true` if intersection notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIntersectionMap
Description	Tests if an intersection map lookup service is supported.
Return	`boolean`		`true` if an intersection map lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIntersectionMapAssignment
Description	Tests if an intersection map service is supported.
Return	`boolean`		`true` if intersection to map assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIntersectionSmartMap
Description	Tests if an intersection smart map lookup service is supported.
Return	`boolean`		`true` if an intersection smart map service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpeedZoneLookup
Description	Tests if looking up speed zones is supported.
Return	`boolean`		`true` if speed zone lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpeedZoneQuery
Description	Tests if querying speed zones is supported.
Return	`boolean`		`true` if speed zone query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpeedZoneSearch
Description	Tests if searching speed zones is supported.
Return	`boolean`		`true` if speed zone search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpeedZoneAdmin
Description	Tests if speed zone administrative service is supported.
Return	`boolean`		`true` if speed zone administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpeedZoneNotification
Description	Tests if a speed zone notification service is supported.
Return	`boolean`		`true` if speed zone notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpeedZoneMap
Description	Tests if a speed zone map lookup service is supported.
Return	`boolean`		`true` if a speed zone map lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpeedZoneMapAssignment
Description	Tests if a speed zone map assignment service is supported.
Return	`boolean`		`true` if a speed zone to map assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpeedZoneSmartMap
Description	Tests if a speed zone smart map service is supported.
Return	`boolean`		`true` if a speed zone smart map service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSignalLookup
Description	Tests if looking up signals is supported.
Return	`boolean`		`true` if signal lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSignalQuery
Description	Tests if querying signals is supported.
Return	`boolean`		`true` if signal query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSignalSearch
Description	Tests if searching signals is supported.
Return	`boolean`		`true` if signal search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSignalAdmin
Description	Tests if signal administrative service is supported.
Return	`boolean`		`true` if signal administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSignalNotification
Description	Tests if a signal notification service is supported.
Return	`boolean`		`true` if signal notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSignalMap
Description	Tests if a signal map lookup service is supported.
Return	`boolean`		`true` if a signal map lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSignalMapAssignment
Description	Tests if a signal map assignment service is supported.
Return	`boolean`		`true` if a signal to map assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSignalSmartMap
Description	Tests if a signal smart map service is supported.
Return	`boolean`		`true` if a signal smart map service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceSignalNotification
Description	Tests if a resource signal notification service is supported.
Return	`boolean`		`true` if a resource signal notification service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObstacleLookup
Description	Tests if looking up obstacles is supported.
Return	`boolean`		`true` if obstacle lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObstacleQuery
Description	Tests if querying obstacles is supported.
Return	`boolean`		`true` if obstacle query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObstacleSearch
Description	Tests if searching obstacles is supported.
Return	`boolean`		`true` if obstacle search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObstacleAdmin
Description	Tests if obstacle administrative service is supported.
Return	`boolean`		`true` if obstacle administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObstacleNotification
Description	Tests if an obstacle notification service is supported.
Return	`boolean`		`true` if obstacle notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObstacleHierarchy
Description	Tests if an obstacle hierarchy service is supported.
Return	`boolean`		`true` if obstacle hierarchy is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObstacleHierarchyDesign
Description	Tests if an obstacle hierarchy design service is supported.
Return	`boolean`		`true` if obstacle hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObstacleMap
Description	Tests if an obstacle map lookup service is supported.
Return	`boolean`		`true` if an obstacle map lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObstacleMapAssignment
Description	Tests if an obstacle map assignment service is supported.
Return	`boolean`		`true` if an obstacle to map assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObstacleSmartMap
Description	Tests if an obstacle smart map service is supported.
Return	`boolean`		`true` if an obstacle smart map service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMappingPathBatch
Description	Tests if a batch mapping path service is supported.
Return	`boolean`		`true` if a mapping path batch service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMappingPathRules
Description	Tests if a mapping path rules service is supported.
Return	`boolean`		`true` if a mapping path rules service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPathRecordTypes
Description	Gets the supported `Path` record types.
Return	`osid.type.TypeList`		a list containing the supported `Path` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathRecordType
Description	Tests if the given `Path` record type is supported.
Parameters	`osid.type.Type`	`pathRecordType`	a `Type` indicating a `Path` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`pathRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPathSearchRecordTypes
Description	Gets the supported `Path` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Path` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPathSearchRecordType
Description	Tests if the given `Path` search record type is supported.
Parameters	`osid.type.Type`	`pathSearchRecordType`	a `Type` indicating a `Path` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`pathSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIntersectionRecordTypes
Description	Gets the supported `Intersection` record types.
Return	`osid.type.TypeList`		a list containing the supported `Intersection` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsIntersectionRecordType
Description	Tests if the given `Intersection` record type is supported.
Parameters	`osid.type.Type`	`intersectionRecordType`	a `Type` indicating an `Intersection` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`intersectionRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIntersectionSearchRecordTypes
Description	Gets the supported `Intersection` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Intersection` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsIntersectionSearchRecordType
Description	Tests if the given `Intersection` search record type is supported.
Parameters	`osid.type.Type`	`intersectionSearchRecordType`	a `Type` indicating an `Intersection` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`intersectionSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneRecordTypes
Description	Gets the supported `SpeedZone` record types.
Return	`osid.type.TypeList`		a list containing the supported `SpeedZone` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpeedZoneRecordType
Description	Tests if the given `SpeedZone` record type is supported.
Parameters	`osid.type.Type`	`speedZoneRecordType`	a `Type` indicating a `SpeedZone` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`speedZoneRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneSearchRecordTypes
Description	Gets the supported `SpeedZone` search types.
Return	`osid.type.TypeList`		a list containing the supported `SpeedZone` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSpeedZoneSearchRecordType
Description	Tests if the given `SpeedZone` search type is supported.
Parameters	`osid.type.Type`	`speedZoneSearchRecordType`	a `Type` indicating a `SpeedZone` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`speedZoneSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSignalRecordTypes
Description	Gets the supported `Signal` record types.
Return	`osid.type.TypeList`		a list containing the supported `Signal` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSignalRecordType
Description	Tests if the given `Signal` record type is supported.
Parameters	`osid.type.Type`	`signalRecordType`	a `Type` indicating a `Signal` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`signalRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSignalSearchRecordTypes
Description	Gets the supported `Signal` search types.
Return	`osid.type.TypeList`		a list containing the supported `Signal` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSignalSearchRecordType
Description	Tests if the given `Signal` search type is supported.
Parameters	`osid.type.Type`	`signalSearchRecordType`	a `Type` indicating a `Signal` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`signalSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleRecordTypes
Description	Gets the supported `Obstacle` record types.
Return	`osid.type.TypeList`		a list containing the supported `Obstacle` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsObstacleRecordType
Description	Tests if the given `Obstacle` record type is supported.
Parameters	`osid.type.Type`	`obstacleRecordType`	a `Type` indicating an `Obstacle` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`obstacleRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleSearchRecordTypes
Description	Gets the supported `Obstacle` search types.
Return	`osid.type.TypeList`		a list containing the supported `Obstacle` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsObstacleSearchRecordType
Description	Tests if the given `Obstacle` search type is supported.
Parameters	`osid.type.Type`	`obstacleSearchRecordType`	a `Type` indicating an `Obstacle` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`obstacleSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResourceVelocityRecordTypes
Description	Gets the supported `ResourceVelocity` record types.
Return	`osid.type.TypeList`		a list containing the supported `ResourceVelocity` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceVelocityRecordType
Description	Tests if the given `ResourceVelocity` record type is supported.
Parameters	`osid.type.Type`	`resourceVelocityRecordType`	a `Type` indicating a `ResourceVelocity` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`resourceVelocityRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.