OSID - osid.mapping.route.MappingRouteProfile Service Interface Definition

Interface	osid.mapping.route.MappingRouteProfile
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	supportsLocationRouting
Description	Tests if a location routing service is supported.
Return	`boolean`		`true` if a location routing 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	supportsRouteLookup
Description	Tests if looking up routes is supported.
Return	`boolean`		`true` if route lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRouteQuery
Description	Tests if querying routes is supported.
Return	`boolean`		`true` if route query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRouteSearch
Description	Tests if searching routes is supported.
Return	`boolean`		`true` if route search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRouteAdmin
Description	Tests if a route administrative service is supported.
Return	`boolean`		`true` if route administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRouteNotification
Description	Tests if a route notification service is supported.
Return	`boolean`		`true` if route notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRouteMap
Description	Tests if a route map lookup service is supported.
Return	`boolean`		`true` if a route map lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRouteMapAssignment
Description	Tests if a route map service is supported.
Return	`boolean`		`true` if a route to map assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRouteSmartMap
Description	Tests if a route smart map service is supported.
Return	`boolean`		`true` if a route smart map lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRoute
Description	Tests if a resource route service is supported.
Return	`boolean`		`true` if a resource route service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRouteAssignment
Description	Tests if a resource route update service is supported.
Return	`boolean`		`true` if a resource route update service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRouteNotification
Description	Tests if a resource route notification service is supported.
Return	`boolean`		`true` if a resource route notification service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMyRoute
Description	Tests if a route service is supported for the current agent.
Return	`boolean`		`true` if my route is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRouteRecordTypes
Description	Gets the supported `Route` record types.
Return	`osid.type.TypeList`		a list containing the supported `Route` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRouteRecordType
Description	Tests if the given `Route` record type is supported.
Parameters	`osid.type.Type`	`routeRecordType`	a `Type` indicating a `Route` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`routeRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRouteSearchRecordTypes
Description	Gets the supported `Route` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Route` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRouteSearchRecordType
Description	Tests if the given `Route` search record type is supported.
Parameters	`osid.type.Type`	`routeSearchRecordType`	a `Type` indicating a `Route` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`routeSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRouteSegmentRecordTypes
Description	Gets the supported `RouteSegment` record types.
Return	`osid.type.TypeList`		a list containing the supported `RouteSegment` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRouteSegmentRecordType
Description	Tests if the given `RouteSegment` record type is supported.
Parameters	`osid.type.Type`	`routeSegmentRecordType`	a `Type` indicating a `RouteSegment` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`supportsRouteSegmentRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRouteProgressRecordTypes
Description	Gets the supported `RouteProgresst` record types.
Return	`osid.type.TypeList`		a list containing the supported `RouteProgress` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRouteProgressRecordType
Description	Tests if the given `RouteProgress` record type is supported.
Parameters	`osid.type.Type`	`routeProgressRecordType`	a `Type` indicating a `RouteProgress` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`supportsRouteProgressRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.