Package org.osid.mapping.route

package org.osid.mapping.route

The Open Service Interface Definitions for the org.osid.mapping.route service.

The Mapping Route OSID provides routing services.

Routes

A Route is between two Locations . A Route has a Distance , an estimated travel time and a set of RouteSegments .

Resources may be tracked along a Route by examining a RouteProgress .

RouteSegments

A Route is composed of a set of RouteSegments . Each RouteSegment represents a specific set of instructions or a segment across a single Path . A RouteSegment contains a Distance and an estimated travel time.

Pre-defined routes may be managed in the Mapping OSID.



Copyright © 2010 Ingenescus. All Rights Reserved.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may modify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.

  • Interfaces
    Class
    Description
    MappingRouteManager
    The mapping route manager provides access to routing sessions and provides interoperability tests for various aspects of this service.
    MappingRouteProfile
    The mapping profile describes the interoperability among mapping services.
    MappingRouteProxyManager
    The mapping proxy manager provides access to routing sessions and provides interoperability tests for various aspects of this service.
    MyRouteSession
    This session defines methods to route between locations.
    ResourceRouteAssignmentSession
    This session defines methods to manage resources on routes.
    ResourceRouteNotificationSession
    This session defines methods to receive notifications on adds/changes to resources on routes in this Map .
    ResourceRouteReceiver
    The resource route receiver is the consumer supplied interface for receiving notifications pertaining to changes of resources along routes.
    ResourceRouteSession
    This session defines methods to track resources on routes.
    Route
    A Route represents one or more paths between two locations.
    RouteAdminSession
    This session creates, updates, and deletes Routes .
    RouteForm
    This is the form for creating and updating Routes .
    RouteList
    Like all OsidLists , RouteList provides a means for accessing Route elements sequentially either one at a time or many at a time.
    RouteLookupSession
    This session provides methods for retrieving premade Routes .
    RouteMapAssignmentSession
    This session provides methods to re-assign Routes to Maps .
    RouteMapSession
    This session provides methods to retrieve Route to Map mappings.
    RouteNotificationSession
    This session defines methods to receive notifications on adds/changes to Routes in this Map .
    RouteProgress
    Route progress defines methods to get information about progress along a route.
    RouteProgressList
    Like all OsidLists , RouteProgressList provides a means for accessing RouteProgress elements sequentially either one at a time or many at a time.
    RouteQuery
    This is the query for searching routes.
    RouteQueryInspector
    This is the query inspector for examining route queries.
    RouteQuerySession
    This session provides methods for searching among Routes .
    RouteReceiver
    The route receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Route objects.
    RouteSearch
    The search interface for governing route searches.
    RouteSearchOrder
    An interface for specifying the ordering of search results.
    RouteSearchResults
    This interface provides a means to capture results of a search.
    RouteSearchSession
    This session provides methods for searching among Routes .
    RouteSegment
    A route segment represents a portion of a route.
    RouteSegmentForm
    This is the form for creating and updating RouteSegments .
    RouteSegmentList
    Like all OsidLists , RouteSegmentList provides a means for accessing RouteSegment elements sequentially either one at a time or many at a time.
    RouteSegmentQuery
    This is the query for searching route segments.
    RouteSegmentQueryInspector
    This is the query inspector for examining route segment queries.
    RouteSegmentSearchOrder
    An interface for specifying the ordering of search results.
    RouteSmartMapSession
    This session manages queries and sequencing to create "smart" dynamic catalogs.
    RoutingSession
    This session defines methods to traverse through a map.