org.osid.mapping.route

Interface MappingRouteProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

MappingRouteManager, MappingRouteProxyManager

public interface MappingRouteProfile
extends OsidProfile

The mapping profile describes the interoperability among mapping services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getRouteProgressRecordTypes() Gets the supported RouteProgresst record types.
TypeList	getRouteRecordTypes() Gets the supported Route record types.
TypeList	getRouteSearchRecordTypes() Gets the supported Route search record types.
TypeList	getRouteSegmentRecordTypes() Gets the supported RouteSegment record types.
boolean	supportsLocationRouting() Tests if a location routing service is supported.
boolean	supportsMyLocation() Tests if a location service is supported for the current agent.
boolean	supportsMyRoute() Tests if a route service is supported for the current agent.
boolean	supportsResourceRoute() Tests if a resource route service is supported.
boolean	supportsResourceRouteAssignment() Tests if a resource route update service is supported.
boolean	supportsResourceRouteNotification() Tests if a resource route notification service is supported.
boolean	supportsRouteAdmin() Tests if a route administrative service is supported.
boolean	supportsRouteLookup() Tests if looking up routes is supported.
boolean	supportsRouteMap() Tests if a route map lookup service is supported.
boolean	supportsRouteMapAssignment() Tests if a route map service is supported.
boolean	supportsRouteNotification() Tests if a route notification service is supported.
boolean	supportsRouteProgressRecordType(Type routeProgressRecordType) Tests if the given RouteProgress record type is supported.
boolean	supportsRouteQuery() Tests if querying routes is supported.
boolean	supportsRouteRecordType(Type routeRecordType) Tests if the given Route record type is supported.
boolean	supportsRouteSearch() Tests if searching routes is supported.
boolean	supportsRouteSearchRecordType(Type routeSearchRecordType) Tests if the given Route search record type is supported.
boolean	supportsRouteSegmentRecordType(Type routeSegmentRecordType) Tests if the given RouteSegment record type is supported.
boolean	supportsRouteSmartMap() Tests if a route smart map service is supported.
boolean	supportsVisibleFederation() Tests if any map federation is exposed.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

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.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLocationRouting

boolean supportsLocationRouting()

Tests if a location routing service is supported.

Returns:

true if a location routing service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMyLocation

boolean supportsMyLocation()

Tests if a location service is supported for the current agent.

Returns:

true if my location is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRouteLookup

boolean supportsRouteLookup()

Tests if looking up routes is supported.

Returns:

true if route lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRouteQuery

boolean supportsRouteQuery()

Tests if querying routes is supported.

Returns:

true if route query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRouteSearch

boolean supportsRouteSearch()

Tests if searching routes is supported.

Returns:

true if route search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRouteAdmin

boolean supportsRouteAdmin()

Tests if a route administrative service is supported.

Returns:

true if route administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRouteNotification

boolean supportsRouteNotification()

Tests if a route notification service is supported.

Returns:

true if route notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRouteMap

boolean supportsRouteMap()

Tests if a route map lookup service is supported.

Returns:

true if a route map lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRouteMapAssignment

boolean supportsRouteMapAssignment()

Tests if a route map service is supported.

Returns:

true if a route to map assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRouteSmartMap

boolean supportsRouteSmartMap()

Tests if a route smart map service is supported.

Returns:

true if a route smart map lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceRoute

boolean supportsResourceRoute()

Tests if a resource route service is supported.

Returns:

true if a resource route service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceRouteAssignment

boolean supportsResourceRouteAssignment()

Tests if a resource route update service is supported.

Returns:

true if a resource route update service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceRouteNotification

boolean supportsResourceRouteNotification()

Tests if a resource route notification service is supported.

Returns:

true if a resource route notification service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMyRoute

boolean supportsMyRoute()

Tests if a route service is supported for the current agent.

Returns:

true if my route is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getRouteRecordTypes

TypeList getRouteRecordTypes()

Gets the supported Route record types.

Returns:

a list containing the supported Route record types

Compliance:

mandatory - This method must be implemented.

supportsRouteRecordType

boolean supportsRouteRecordType(Type routeRecordType)

Tests if the given Route record type is supported.

Parameters:

routeRecordType - a Type indicating a Route record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - routeRecordType is null

Compliance:

mandatory - This method must be implemented.

getRouteSearchRecordTypes

TypeList getRouteSearchRecordTypes()

Gets the supported Route search record types.

Returns:

a list containing the supported Route search record types

Compliance:

mandatory - This method must be implemented.

supportsRouteSearchRecordType

boolean supportsRouteSearchRecordType(Type routeSearchRecordType)

Tests if the given Route search record type is supported.

Parameters:

routeSearchRecordType - a Type indicating a Route search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - routeSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getRouteSegmentRecordTypes

TypeList getRouteSegmentRecordTypes()

Gets the supported RouteSegment record types.

Returns:

a list containing the supported RouteSegment record types

Compliance:

mandatory - This method must be implemented.

supportsRouteSegmentRecordType

boolean supportsRouteSegmentRecordType(Type routeSegmentRecordType)

Tests if the given RouteSegment record type is supported.

Parameters:

routeSegmentRecordType - a Type indicating a RouteSegment record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - supportsRouteSegmentRecordType is null

Compliance:

mandatory - This method must be implemented.

getRouteProgressRecordTypes

TypeList getRouteProgressRecordTypes()

Gets the supported RouteProgresst record types.

Returns:

a list containing the supported RouteProgress record types

Compliance:

mandatory - This method must be implemented.

supportsRouteProgressRecordType

boolean supportsRouteProgressRecordType(Type routeProgressRecordType)

Tests if the given RouteProgress record type is supported.

Parameters:

routeProgressRecordType - a Type indicating a RouteProgress record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - supportsRouteProgressRecordType is null

Compliance:

mandatory - This method must be implemented.