Interface MappingManager

All Superinterfaces:

AutoCloseable, Closeable, MappingProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface MappingManager
extends OsidManager, MappingProfile

The mapping manager provides access to mapping sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• LocationLookupSession : a session to retrieve locations
• LocationQuerySession : a session to query for locations
• LocationSearchSession : a session to search for locations
• LocationAdminSession : a session to create and delete locations
• LocationNotificationSession : a session to receive notifications pertaining to location changes
• LocationHierarchySession : a session to examine locations in a hierarchy
• LocationHierarchyAssignmentSession : a session to traverse the location hierarchy
• LocationMapSession : a session to look up location to map mappings
• LocationMapAssignmentSession : a session to manage location to map mappings
• LocationSmartMapSession : a session to manage dynamic maps of locations

• LocationAdjacencySession : a session to query neighboring locations
• LocationSpatialSession : a session to lookup locations spatially
• ResourceLocationSession : a session query resources at locations
• ResourceLocationUpdateSession : a session to assign resources to locations
• ResourceLocationNotificationSession : a session to subscribe to notifications when resources move among locations
• ResourcePositionNotificationSession : a session to subscribe to notifications when resources change positions
• MyLocationSession : a session to query locations for the user agent

• MapLookupSession : a session to retrieve maps
• MapQuerySession : a session to search for maps
• MapSearchSession : a session to search for maps
• MapAdminSession : a session to create and delete maps
• MapNotificationSession : a session to receive notifications pertaining to map changes
• MapHierarchySession : a session to traverse a hierarchy of map
• MapHierarchyDesignSession : a session to manage a map hierarchy

Method Summary

Modifier and Type	Method	Description
LocationAdjacencySession	getLocationAdjacencySession()	Gets the OsidSession associated with the location adjacency service.
LocationAdjacencySession	getLocationAdjacencySessionForMap(Id mapId)	Gets the OsidSession associated with the location adjacency service for the given map.
LocationAdminSession	getLocationAdminSession()	Gets the OsidSession associated with the location administration service.
LocationAdminSession	getLocationAdminSessionForMap(Id mapId)	Gets the OsidSession associated with the location administration service for the given map.
LocationHierarchyDesignSession	getLocationHierarchyDesignSession()	Gets the OsidSession associated with the location hierarchy design service.
LocationHierarchyDesignSession	getLocationHierarchyDesignSessionForMap(Id mapId)	Gets the OsidSession associated with the location hierarchy design service for the given map.
LocationHierarchySession	getLocationHierarchySession()	Gets the OsidSession associated with the location hierarchy service.
LocationHierarchySession	getLocationHierarchySessionForMap(Id mapId)	Gets the OsidSession associated with the location hierarchy service for the given map.
LocationLookupSession	getLocationLookupSession()	Gets the OsidSession associated with the location lookup service.
LocationLookupSession	getLocationLookupSessionForMap(Id mapId)	Gets the OsidSession associated with the location lookup service for the given map.
LocationMapAssignmentSession	getLocationMapAssignmentSession()	Gets the OsidSession associated with assigning locations to maps.
LocationMapSession	getLocationMapSession()	Gets the OsidSession to lookup location/map mappings.
LocationNotificationSession	getLocationNotificationSession(LocationReceiver locationReceiver)	Gets the OsidSession associated with the location notification service.
LocationNotificationSession	getLocationNotificationSessionForMap(LocationReceiver locationReceiver, Id mapId)	Gets the OsidSession associated with the location notification service for the given map.
LocationQuerySession	getLocationQuerySession()	Gets the OsidSession associated with the location query service.
LocationQuerySession	getLocationQuerySessionForMap(Id mapId)	Gets the OsidSession associated with the location query service for the given map.
LocationSearchSession	getLocationSearchSession()	Gets the OsidSession associated with the location search service.
LocationSearchSession	getLocationSearchSessionForMap(Id mapId)	Gets the OsidSession associated with the location search service for the given map.
LocationSmartMapSession	getLocationSmartMapSession(Id mapId)	Gets the OsidSession to manage locatin smart maps.
LocationSpatialSession	getLocationSpatialSession()	Gets the OsidSession associated with the location spatial service.
LocationSpatialSession	getLocationSpatialSessionForMap(Id mapId)	Gets the OsidSession associated with the location spatial service for the given map.
MapAdminSession	getMapAdminSession()	Gets the OsidSession associated with the map administrative service.
MapHierarchyDesignSession	getMapHierarchyDesignSession()	Gets the OsidSession associated with the map hierarchy design service.
MapHierarchySession	getMapHierarchySession()	Gets the OsidSession associated with the map hierarchy service.
MapLookupSession	getMapLookupSession()	Gets the OsidSession associated with the map lookup service.
MapNotificationSession	getMapNotificationSession(MapReceiver mapReceiver)	Gets the OsidSession associated with the map notification service.
MappingBatchManager	getMappingBatchManager()	Gets the mapping batch manager.
MappingPathManager	getMappingPathManager()	Gets the mapping path manager.
MappingRouteManager	getMappingRouteManager()	Gets the mapping route manager.
MapQuerySession	getMapQuerySession()	Gets the OsidSession associated with the map query service.
MapSearchSession	getMapSearchSession()	Gets the OsidSession associated with the map search service.
MyLocationSession	getMyLocationSession()	Gets the OsidSession associated with the my location service.
MyLocationSession	getMyLocationSessionForMap(Id mapId)	Gets the OsidSession associated with the my location service for the given map.
ResourceLocationNotificationSession	getResourceLocationNotificationSession(ResourceLocationReceiver resourceLocationReceiver)	Gets the OsidSession associated with the resource location notification service.
ResourceLocationNotificationSession	getResourceLocationNotificationSessionForMap(ResourceLocationReceiver resourceLocationReceiver, Id mapId)	Gets the OsidSession associated with the resource location notification service for the given map.
ResourceLocationSession	getResourceLocationSession()	Gets the OsidSession associated with the resource location service.
ResourceLocationSession	getResourceLocationSessionForMap(Id mapId)	Gets the OsidSession associated with the resource location service for the given map.
ResourceLocationUpdateSession	getResourceLocationUpdateSession()	Gets the OsidSession associated with the resource location update service.
ResourceLocationUpdateSession	getResourceLocationUpdateSessionForMap(Id mapId)	Gets the OsidSession associated with the resource location update service for the given map.
ResourcePositionNotificationSession	getResourcePositionNotificationSession(ResourcePositionReceiver resourcePositionReceiver)	Gets the OsidSession associated with the resource position notification service.
ResourcePositionNotificationSession	getResourcePositionNotificationSessionForMap(ResourcePositionReceiver resourcePositionReceiver, Id mapId)	Gets the OsidSession associated with the resource position notification service for the given map.

Methods inherited from interface Closeable

close

Methods inherited from interface MappingProfile

getCoordinateTypes, getHeadingTypes, getLocationRecordTypes, getLocationSearchRecordTypes, getMapRecordTypes, getMapSearchRecordTypes, getResourceLocationRecordTypes, getSpatialUnitRecordTypes, supportsCoordinateType, supportsHeadingType, supportsLocationAdjacency, supportsLocationAdmin, supportsLocationHierarchy, supportsLocationHierarchyDesign, supportsLocationLookup, supportsLocationMap, supportsLocationMapAssignment, supportsLocationNotification, supportsLocationQuery, supportsLocationRecordType, supportsLocationSearch, supportsLocationSearchRecordType, supportsLocationSmartMap, supportsLocationSpatial, supportsMapAdmin, supportsMapHierarchy, supportsMapHierarchyDesign, supportsMapLookup, supportsMapNotification, supportsMappingBatch, supportsMappingPath, supportsMappingRoute, supportsMapQuery, supportsMapRecordType, supportsMapSearch, supportsMapSearchRecordType, supportsMyLocation, supportsResourceLocation, supportsResourceLocationNotification, supportsResourceLocationRecordType, supportsResourceLocationUpdate, supportsResourcePositionNotification, supportsSpatialUnitRecordType, supportsVisibleFederation

Modifier and Type	Method	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 OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getLocationLookupSession

LocationLookupSession getLocationLookupSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the location lookup service.

Returns:

a LocationLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationLookup()} is {@code true} .

getLocationLookupSessionForMap

LocationLookupSession getLocationLookupSessionForMap(Id mapId)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the location lookup service for the given map.

Parameters:

mapId - the Id of the map

Returns:

a LocationLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationLookup()} and {@code supportsVisibleFederation()} are {@code true}

getLocationQuerySession

LocationQuerySession getLocationQuerySession()
                                      throws OperationFailedException

Gets the OsidSession associated with the location query service.

Returns:

a LocationQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationQuery()} is {@code true} .

getLocationQuerySessionForMap

LocationQuerySession getLocationQuerySessionForMap(Id mapId)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the location query service for the given map.

Parameters:

mapId - the Id of the Map

Returns:

a LocationQuerySession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationQuery()} and {@code supportsVisibleFederation()} are {@code true}

getLocationSearchSession

LocationSearchSession getLocationSearchSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the location search service.

Returns:

a LocationSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationSearch()} is {@code true} .

getLocationSearchSessionForMap

LocationSearchSession getLocationSearchSessionForMap(Id mapId)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the location search service for the given map.

Parameters:

mapId - the Id of the Map

Returns:

a LocationSearchSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationSearch()} and {@code supportsVisibleFederation()} are {@code true}

getLocationAdminSession

LocationAdminSession getLocationAdminSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the location administration service.

Returns:

a LocationAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationAdmin()} is {@code true} .

getLocationAdminSessionForMap

LocationAdminSession getLocationAdminSessionForMap(Id mapId)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the location administration service for the given map.

Parameters:

mapId - the Id of the Map

Returns:

a LocationAdminSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getLocationNotificationSession

LocationNotificationSession getLocationNotificationSession(LocationReceiver locationReceiver)
                                                    throws OperationFailedException

Gets the OsidSession associated with the location notification service.

Parameters:

locationReceiver - the notification callback

Returns:

a LocationNotificationSession

Throws:

NullArgumentException - locationReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationNotification()} is {@code true} .

getLocationNotificationSessionForMap

LocationNotificationSession getLocationNotificationSessionForMap(LocationReceiver locationReceiver,
 Id mapId)
                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the location notification service for the given map.

Parameters:

locationReceiver - the notification callback

mapId - the Id of the Map

Returns:

a LocationNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - locationReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationNotification()} and {@code supportsVisibleFederation()} are {@code true}

getLocationHierarchySession

LocationHierarchySession getLocationHierarchySession()
                                              throws OperationFailedException

Gets the OsidSession associated with the location hierarchy service.

Returns:

a LocationHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationHierarchy()} is {@code true} .

getLocationHierarchySessionForMap

LocationHierarchySession getLocationHierarchySessionForMap(Id mapId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the location hierarchy service for the given map.

Parameters:

mapId - the Id of the Map

Returns:

a LocationHierarchySession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationHierarchy() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationHierarchy()} and {@code supportsVisibleFederation()} are {@code true}

getLocationHierarchyDesignSession

LocationHierarchyDesignSession getLocationHierarchyDesignSession()
                                                          throws OperationFailedException

Gets the OsidSession associated with the location hierarchy design service.

Returns:

a LocationHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationHierarchyDesign()} is {@code true} .

getLocationHierarchyDesignSessionForMap

LocationHierarchyDesignSession getLocationHierarchyDesignSessionForMap(Id mapId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the location hierarchy design service for the given map.

Parameters:

mapId - the Id of the Map

Returns:

a LocationHierarchySession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationHierarchyDesign() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationHierarchyDesign()} and {@code supportsVisibleFederation()} are {@code true}

getLocationMapSession

LocationMapSession getLocationMapSession()
                                  throws OperationFailedException

Gets the OsidSession to lookup location/map mappings.

Returns:

a LocationMapSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationMap() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationMap()} is {@code true} .

getLocationMapAssignmentSession

LocationMapAssignmentSession getLocationMapAssignmentSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with assigning locations to maps.

Returns:

a LocationMapAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationMapAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationMapAssignment()} is {@code true} .

getLocationSmartMapSession

LocationSmartMapSession getLocationSmartMapSession(Id mapId)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage locatin smart maps.

Parameters:

mapId - the Id of the Map

Returns:

a LocationSmartMapSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationSmartMap() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationSmartMap()} is {@code true} .

getLocationAdjacencySession

LocationAdjacencySession getLocationAdjacencySession()
                                              throws OperationFailedException

Gets the OsidSession associated with the location adjacency service.

Returns:

a LocationAdjacencySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationAdjacency() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationAdjacency()} is {@code true} .

getLocationAdjacencySessionForMap

LocationAdjacencySession getLocationAdjacencySessionForMap(Id mapId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the location adjacency service for the given map.

Parameters:

mapId - the Id of the Map

Returns:

a LocationAdjacencySession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationAdjacency() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationAdjacency()} and {@code supportsVisibleFederation()} are {@code true}

getLocationSpatialSession

LocationSpatialSession getLocationSpatialSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the location spatial service.

Returns:

a LocationSpatialSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationSpatial() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationSpatial()} is {@code true} .

getLocationSpatialSessionForMap

LocationSpatialSession getLocationSpatialSessionForMap(Id mapId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the location spatial service for the given map.

Parameters:

mapId - the Id of the Map

Returns:

a LocationSpatialSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationSpatial() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLocationSpatial()} and {@code supportsVisibleFederation()} are {@code true}

getResourceLocationSession

ResourceLocationSession getResourceLocationSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the resource location service.

Returns:

a ResourceLocationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLocation() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceLocation()} is {@code true} .

getResourceLocationSessionForMap

ResourceLocationSession getResourceLocationSessionForMap(Id mapId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the resource location service for the given map.

Parameters:

mapId - the Id of the Map

Returns:

a ResourceLocationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLocation() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceLocation()} and {@code supportsVisibleFederation()} are {@code true}

getResourceLocationUpdateSession

ResourceLocationUpdateSession getResourceLocationUpdateSession()
                                                        throws OperationFailedException

Gets the OsidSession associated with the resource location update service.

Returns:

a ResourceLocationUpdateSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLocationUpdate() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceLocationUpdate()} is {@code true} .

getResourceLocationUpdateSessionForMap

ResourceLocationUpdateSession getResourceLocationUpdateSessionForMap(Id mapId)
                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the resource location update service for the given map.

Parameters:

mapId - the Id of the Map

Returns:

a ResourceLocationUpdateSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLocationUpdate() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceLocationUpdate()} and {@code supportsVisibleFederation()} are {@code true}

getResourceLocationNotificationSession

ResourceLocationNotificationSession getResourceLocationNotificationSession(ResourceLocationReceiver resourceLocationReceiver)
                                                                    throws OperationFailedException

Gets the OsidSession associated with the resource location notification service.

Parameters:

resourceLocationReceiver - the notification callback

Returns:

a ResourceLocationNotificationSession

Throws:

NullArgumentException - resourceLocationReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLocationNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceLocationNotification()} is {@code true} .

getResourceLocationNotificationSessionForMap

ResourceLocationNotificationSession getResourceLocationNotificationSessionForMap(ResourceLocationReceiver resourceLocationReceiver,
 Id mapId)
                                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the resource location notification service for the given map.

Parameters:

resourceLocationReceiver - the notification callback

mapId - the Id of the Map

Returns:

a ResourceLocationNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - resourceLocationReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLocationNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceLocationNotification()} and {@code supportsVisibleFederation()} are {@code true}

getResourcePositionNotificationSession

ResourcePositionNotificationSession getResourcePositionNotificationSession(ResourcePositionReceiver resourcePositionReceiver)
                                                                    throws OperationFailedException

Gets the OsidSession associated with the resource position notification service.

Parameters:

resourcePositionReceiver - the notification callback

Returns:

a ResourcePositionNotificationSession

Throws:

NullArgumentException - resourcePositionReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourcePositionNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsResourcePositionNotification()} is {@code true} .

getResourcePositionNotificationSessionForMap

ResourcePositionNotificationSession getResourcePositionNotificationSessionForMap(ResourcePositionReceiver resourcePositionReceiver,
 Id mapId)
                                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the resource position notification service for the given map.

Parameters:

resourcePositionReceiver - the notification callback

mapId - the Id of the Map

Returns:

a ResourcePositionNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - resourcePositionReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourcePositionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResourcePositionNotification()} and {@code supportsVisibleFederation()} are {@code true}

getMyLocationSession

MyLocationSession getMyLocationSession()
                                throws OperationFailedException

Gets the OsidSession associated with the my location service.

Returns:

a MyLocationLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMyLocationLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsMyLocationLookup()} is {@code true} .

getMyLocationSessionForMap

MyLocationSession getMyLocationSessionForMap(Id mapId)
                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the my location service for the given map.

Parameters:

mapId - the Id of the map

Returns:

a MyLocationLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyLocationLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMyLocationLookup()} and {@code supportsVisibleFederation()} are {@code true}

getMapLookupSession

MapLookupSession getMapLookupSession()
                              throws OperationFailedException

Gets the OsidSession associated with the map lookup service.

Returns:

a MapLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMapLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsMapLookup()} is {@code true} .

getMapQuerySession

MapQuerySession getMapQuerySession()
                            throws OperationFailedException

Gets the OsidSession associated with the map query service.

Returns:

a MapQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMapQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsMapQuery()} is {@code true} .

getMapSearchSession

MapSearchSession getMapSearchSession()
                              throws OperationFailedException

Gets the OsidSession associated with the map search service.

Returns:

a MapSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMapSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsMapSearch()} is {@code true} .

getMapAdminSession

MapAdminSession getMapAdminSession()
                            throws OperationFailedException

Gets the OsidSession associated with the map administrative service.

Returns:

a MapAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMapAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsMapAdmin()} is {@code true} .

getMapNotificationSession

MapNotificationSession getMapNotificationSession(MapReceiver mapReceiver)
                                          throws OperationFailedException

Gets the OsidSession associated with the map notification service.

Parameters:

mapReceiver - the notification callback

Returns:

a MapNotificationSession

Throws:

NullArgumentException - mapReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMapNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsMapNotification()} is {@code true} .

getMapHierarchySession

MapHierarchySession getMapHierarchySession()
                                    throws OperationFailedException

Gets the OsidSession associated with the map hierarchy service.

Returns:

a MapHierarchySession for maps

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMapHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsMapHierarchy()} is {@code true} .

getMapHierarchyDesignSession

MapHierarchyDesignSession getMapHierarchyDesignSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the map hierarchy design service.

Returns:

a HierarchyDesignSession for maps

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMapHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsMapHierarchyDesign()} is {@code true} .

getMappingBatchManager

MappingBatchManager getMappingBatchManager()
                                    throws OperationFailedException

Gets the mapping batch manager.

Returns:

a MappingBatchManager for paths

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMappingBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsMappingBatch()} is {@code true} .

getMappingPathManager

MappingPathManager getMappingPathManager()
                                  throws OperationFailedException

Gets the mapping path manager.

Returns:

a MappingPathManager for paths

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMappingPath() is false

Compliance:

optional - This method must be implemented if {@code supportsMappingPath()} is {@code true} .

getMappingRouteManager

MappingRouteManager getMappingRouteManager()
                                    throws OperationFailedException

Gets the mapping route manager.

Returns:

a MappingRouteManager for routes

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMappingRoute() is false

Compliance:

optional - This method must be implemented if {@code supportsMappingRoute()} is {@code true} .