org.osid.topology

Interface Summary
Interface	Description
Edge	A `Edge` represents relationship between two nodes.
EdgeAdminSession	This session creates, updates, and deletes `Edges.`
EdgeForm	This is the form for creating and updating `Edges.`
EdgeGraphAssignmentSession	This session provides methods to re-assign `Edges` to `Graph` objects An `Edge` may appear in multiple `Graph` objects and removing the last reference to an `Edge` is the equivalent of deleting it.
EdgeGraphSession	This session provides methods to retrieve `Edge` to `Graph` mappings.
EdgeList	Like all `OsidLists,` `EdgeList` provides a means for accessing `Edge` elements sequentially either one at a time or many at a time.
EdgeLookupSession	This session provides methods for retrieving `Edge` objects.
EdgeNotificationSession	This session defines methods to receive notifications on adds/changes to `Edge` objects in this `Graph.`
EdgeQuery	This is the query for searching edges.
EdgeQueryInspector	This is the query inspector for examining edge queries.
EdgeQuerySession	This session provides methods for searching among `Edge` objects.
EdgeReceiver	The edge receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Edge` objects.
EdgeSearch	The search interface for governing edge searches.
EdgeSearchOrder	An interface for specifying the ordering of search results.
EdgeSearchResults	This interface provides a means to capture results of a search.
EdgeSearchSession	This session provides methods for searching among `Edge` objects.
EdgeSmartGraphSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Graph	A `Graph` represents a collection of nodes and edges.
GraphAdminSession	This session creates, updates, and deletes `Graphs.`
GraphForm	This is the form for creating and updating graphs.
GraphHierarchyDesignSession	This session defines methods for managing a hierarchy of `Graph` objects.
GraphHierarchySession	This session defines methods for traversing a hierarchy of `Graph` objects.
GraphList	Like all `OsidLists,` `GraphList` provides a means for accessing `Graph` elements sequentially either one at a time or many at a time.
GraphLookupSession	This session provides methods for retrieving `Graph` objects.
GraphNode	This interface is a container for a partial hierarchy retrieval.
GraphNodeList	Like all `OsidLists,` `GraphNodeList` provides a means for accessing `GraphNode` elements sequentially either one at a time or many at a time.
GraphNotificationSession	This session defines methods to receive notifications on adds/changes to `Graph` objects.
GraphQuery	This is the query for searching graphs.
GraphQueryInspector	This is the query inspector for examining graph queries.
GraphQuerySession	This session provides methods for searching among `Graph` objects.
GraphReceiver	The graph receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Graph` objects.
GraphSearch	The search interface for governing graph searches.
GraphSearchOrder	An interface for specifying the ordering of search results.
GraphSearchResults	This interface provides a means to capture results of a search.
GraphSearchSession	This session provides methods for searching among `Graph` objects.
Node	A `Node` represents a node in a `Graph.`
NodeAdminSession	This session creates, updates, and deletes `Nodes.`
NodeForm	This is the form for creating and updating `Nodes.`
NodeGraphAssignmentSession	This session provides methods to re-assign `Nodes` to `Graph` objects A `Node` may appear in multiple `Graph` objects and removing the last reference to a `Node` is the equivalent of deleting it.
NodeGraphSession	This session provides methods to retrieve `Node` to `Graph` mappings.
NodeList	Like all `OsidLists,` `NodeList` provides a means for accessing `Node` elements sequentially either one at a time or many at a time.
NodeLookupSession	This session defines methods for retrieving nodes.
NodeNotificationSession	This session defines methods to receive notifications on adds/changes to `Node` objects in this `Graph.`
NodeQuery	This is the query for searching nodes.
NodeQueryInspector	This is the query inspector for examining node queries.
NodeQuerySession	This session provides methods for searching among `Node` objects.
NodeReceiver	The node receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted nodes.
NodeSearch	The search interface for governing node searches.
NodeSearchOrder	An interface for specifying the ordering of search results.
NodeSearchResults	This interface provides a means to capture results of a search.
NodeSearchSession	This session provides methods for searching among `Node` objects.
NodeSmartGraphSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
TopologyManager	The topology manager provides access to topology sessions and provides interoperability tests for various aspects of this service.
TopologyProfile	The topology profile describes the interoperability among topology services.
TopologyProxyManager	The topology manager provides access to topology sessions and provides interoperability tests for various aspects of this service.
TopologyRoutingSession	This session defines methods to route between nodes.
TopologyTraversalSession	This session defines methods to traverse through a graph.

Package org.osid.topology Description

The Open Service Interface Definitions for the org.osid.topology service.

The Topology OSID provides defines a service to manage and connect nodes.

Edges

Nodes are connected to each other using Edges that allow for the storage of routing data. An Edge represents a single connection between two Nodes, and may have an optional direction assigned. The Edge defines cost and distance metrics that aid in the display and/or routing within the topology.

Topology Traversal

The traversal and routing sessions offers a different view of the topology than the typical node and edge lookup sessions. Methods exist to query neighboring nodes, inbound and outbound edges, as well as determine the shortest or least expensive route between any two nodes in a topology.

Graph Cataloging

Topologies are organized into Graphs which may also be hierarchical. Federated graphs may serve to link multiple topologies together, and offers a means of defining a set of layers among different node or edge types. The ability to assign nodes and edges to different Graphs offers a lot of flexibility, although a provider may or may not require an Edge to be defined in the same Graph as the connected Nodes.

Sub Packages

The Topology OSID includes a Topology Path OSID for managing paths through topologies and a Topology Rules OSID for mnaging the effectiveness of Edges.

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.