org.osid.mapping

Interface MappingProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

MappingManager, MappingProxyManager

public interface MappingProfile
extends OsidProfile

The mapping profile describes the interoperability among mapping services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getCoordinateTypes() Gets the supported Coordinate types.
TypeList	getHeadingTypes() Gets the supported Heading types.
TypeList	getLocationRecordTypes() Gets the supported Location record types.
TypeList	getLocationSearchRecordTypes() Gets the supported Location search types.
TypeList	getMapRecordTypes() Gets the supported Map record types.
TypeList	getMapSearchRecordTypes() Gets the supported Map search record types.
TypeList	getResourceLocationRecordTypes() Gets the supported ResourceLocation record types.
TypeList	getSpatialUnitRecordTypes() Gets the supported SpatialUnit record types.
boolean	supportsCoordinateType(Type coordinateType) Tests if the given Coordinate type is supported.
boolean	supportsHeadingType(Type headingType) Tests if the given Heading type is supported.
boolean	supportsLocationAdjacency() Tests if a location adjacency service is supported.
boolean	supportsLocationAdmin() Tests if location administrative service is supported.
boolean	supportsLocationHierarchy() Tests if a location hierarchy service is supported.
boolean	supportsLocationHierarchyDesign() Tests if a location hierarchy design service is supported.
boolean	supportsLocationLookup() Tests if looking up locations is supported.
boolean	supportsLocationMap() Tests if a location map lookup service is supported.
boolean	supportsLocationMapAssignment() Tests if a location map assignment service is supported.
boolean	supportsLocationNotification() Tests if a location notification service is supported.
boolean	supportsLocationQuery() Tests if querying locations is supported.
boolean	supportsLocationRecordType(Type locationRecordType) Tests if the given Location record type is supported.
boolean	supportsLocationSearch() Tests if searching locations is supported.
boolean	supportsLocationSearchRecordType(Type locationSearchRecordType) Tests if the given Location search type is supported.
boolean	supportsLocationSmartMap() Tests if a location smart map service is supported.
boolean	supportsLocationSpatial() Tests if a location spatial service is supported.
boolean	supportsMapAdmin() Tests if map administrative service is supported.
boolean	supportsMapHierarchy() Tests for the availability of a map hierarchy traversal service.
boolean	supportsMapHierarchyDesign() Tests for the availability of a map hierarchy design service.
boolean	supportsMapLookup() Tests if looking up maps is supported.
boolean	supportsMapNotification() Tests if a map notification service is supported.
boolean	supportsMappingBatch() Tests if the mapping batch service is supported.
boolean	supportsMappingPath() Tests if the mapping path service is supported.
boolean	supportsMappingRoute() Tests if the mapping route service is supported.
boolean	supportsMapQuery() Tests if querying maps is supported.
boolean	supportsMapRecordType(Type mapRecordType) Tests if the given Map record type is supported.
boolean	supportsMapSearch() Tests if searching maps is supported.
boolean	supportsMapSearchRecordType(Type mapSearchRecordType) Tests if the given Map search record type is supported.
boolean	supportsMyLocation() Tests if a location service is supported for the current agent.
boolean	supportsResourceLocation() Tests if a resource location service is supported.
boolean	supportsResourceLocationNotification() Tests if a resource location notification service is supported.
boolean	supportsResourceLocationRecordType(Type resourceLocationRecordType) Tests if the given ResourceLocationRecord record type is supported.
boolean	supportsResourceLocationUpdate() Tests if a resource location update service is supported.
boolean	supportsResourcePositionNotification() Tests if a resource position notification service is supported.
boolean	supportsSpatialUnitRecordType(Type spatialUnitRecordType) Tests if the given SpatialUnit record type 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.

supportsLocationLookup

boolean supportsLocationLookup()

Tests if looking up locations is supported.

Returns:

true if location lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLocationQuery

boolean supportsLocationQuery()

Tests if querying locations is supported.

Returns:

true if location query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLocationSearch

boolean supportsLocationSearch()

Tests if searching locations is supported.

Returns:

true if location search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLocationAdmin

boolean supportsLocationAdmin()

Tests if location administrative service is supported.

Returns:

true if location administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLocationNotification

boolean supportsLocationNotification()

Tests if a location notification service is supported.

Returns:

true if location notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLocationHierarchy

boolean supportsLocationHierarchy()

Tests if a location hierarchy service is supported.

Returns:

true if location hierarchy is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLocationHierarchyDesign

boolean supportsLocationHierarchyDesign()

Tests if a location hierarchy design service is supported.

Returns:

true if location hierarchy design is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLocationMap

boolean supportsLocationMap()

Tests if a location map lookup service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsLocationMapAssignment

boolean supportsLocationMapAssignment()

Tests if a location map assignment service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsLocationSmartMap

boolean supportsLocationSmartMap()

Tests if a location smart map service is supported.

Returns:

true if a location smart map service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLocationAdjacency

boolean supportsLocationAdjacency()

Tests if a location adjacency service is supported.

Returns:

true if a location adjacency service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLocationSpatial

boolean supportsLocationSpatial()

Tests if a location spatial service is supported.

Returns:

true if a location spatial service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceLocation

boolean supportsResourceLocation()

Tests if a resource location service is supported.

Returns:

true if a resource location service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsResourceLocationUpdate

boolean supportsResourceLocationUpdate()

Tests if a resource location update service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsResourceLocationNotification

boolean supportsResourceLocationNotification()

Tests if a resource location notification service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsResourcePositionNotification

boolean supportsResourcePositionNotification()

Tests if a resource position notification service is supported.

Returns:

true if a resource position notification 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.

supportsMapLookup

boolean supportsMapLookup()

Tests if looking up maps is supported.

Returns:

true if map lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMapQuery

boolean supportsMapQuery()

Tests if querying maps is supported.

Returns:

true if a map query service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMapSearch

boolean supportsMapSearch()

Tests if searching maps is supported.

Returns:

true if map search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMapAdmin

boolean supportsMapAdmin()

Tests if map administrative service is supported.

Returns:

true if map administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMapNotification

boolean supportsMapNotification()

Tests if a map notification service is supported.

Returns:

true if map notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMapHierarchy

boolean supportsMapHierarchy()

Tests for the availability of a map hierarchy traversal service.

Returns:

true if map hierarchy traversal is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsMapHierarchyDesign

boolean supportsMapHierarchyDesign()

Tests for the availability of a map hierarchy design service.

Returns:

true if map hierarchy design is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMappingBatch

boolean supportsMappingBatch()

Tests if the mapping batch service is supported.

Returns:

true if maping batch service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMappingPath

boolean supportsMappingPath()

Tests if the mapping path service is supported.

Returns:

true if maping path service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMappingRoute

boolean supportsMappingRoute()

Tests if the mapping route service is supported.

Returns:

true if maping route service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getLocationRecordTypes

TypeList getLocationRecordTypes()

Gets the supported Location record types.

Returns:

a list containing the supported Location record types

Compliance:

mandatory - This method must be implemented.

supportsLocationRecordType

boolean supportsLocationRecordType(Type locationRecordType)

Tests if the given Location record type is supported.

Parameters:

locationRecordType - a Type indicating a Location record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - locationRecordType is null

Compliance:

mandatory - This method must be implemented.

getLocationSearchRecordTypes

TypeList getLocationSearchRecordTypes()

Gets the supported Location search types.

Returns:

a list containing the supported Location search types

Compliance:

mandatory - This method must be implemented.

supportsLocationSearchRecordType

boolean supportsLocationSearchRecordType(Type locationSearchRecordType)

Tests if the given Location search type is supported.

Parameters:

locationSearchRecordType - a Type indicating a Location search type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - locationSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getMapRecordTypes

TypeList getMapRecordTypes()

Gets the supported Map record types.

Returns:

a list containing the supported Map types

Compliance:

mandatory - This method must be implemented.

supportsMapRecordType

boolean supportsMapRecordType(Type mapRecordType)

Tests if the given Map record type is supported.

Parameters:

mapRecordType - a Type indicating a Map record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - mapRecordType is null

Compliance:

mandatory - This method must be implemented.

getMapSearchRecordTypes

TypeList getMapSearchRecordTypes()

Gets the supported Map search record types.

Returns:

a list containing the supported Map search record types

Compliance:

mandatory - This method must be implemented.

supportsMapSearchRecordType

boolean supportsMapSearchRecordType(Type mapSearchRecordType)

Tests if the given Map search record type is supported.

Parameters:

mapSearchRecordType - a Type indicating a Map search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - mapSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getResourceLocationRecordTypes

TypeList getResourceLocationRecordTypes()

Gets the supported ResourceLocation record types.

Returns:

a list containing the supported ResourceLocation record types

Compliance:

mandatory - This method must be implemented.

supportsResourceLocationRecordType

boolean supportsResourceLocationRecordType(Type resourceLocationRecordType)

Tests if the given ResourceLocationRecord record type is supported.

Parameters:

resourceLocationRecordType - a Type indicating a ResourceLocation type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - resourceLocationRecordType is null

Compliance:

mandatory - This method must be implemented.

getCoordinateTypes

TypeList getCoordinateTypes()

Gets the supported Coordinate types.

Returns:

a list containing the supported Coordinate types

Compliance:

mandatory - This method must be implemented.

supportsCoordinateType

boolean supportsCoordinateType(Type coordinateType)

Tests if the given Coordinate type is supported.

Parameters:

coordinateType - a Type indicating a Coordinate type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - coordinateType is null

Compliance:

mandatory - This method must be implemented.

getHeadingTypes

TypeList getHeadingTypes()

Gets the supported Heading types.

Returns:

a list containing the supported Heading types

Compliance:

mandatory - This method must be implemented.

supportsHeadingType

boolean supportsHeadingType(Type headingType)

Tests if the given Heading type is supported.

Parameters:

headingType - a Type indicating a Heading type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - headingType is null

Compliance:

mandatory - This method must be implemented.

getSpatialUnitRecordTypes

TypeList getSpatialUnitRecordTypes()

Gets the supported SpatialUnit record types.

Returns:

a list containing the supported SpatialUnit record types

Compliance:

mandatory - This method must be implemented.

supportsSpatialUnitRecordType

boolean supportsSpatialUnitRecordType(Type spatialUnitRecordType)

Tests if the given SpatialUnit record type is supported.

Parameters:

spatialUnitRecordType - a Type indicating a SpatialUnit record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - spatialUnitRecordType is null

Compliance:

mandatory - This method must be implemented.