Interface TopologyProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
TopologyManager, TopologyProxyManager
public interface TopologyProfile extends OsidProfile

The topology profile describes the interoperability among topology services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if any graph federation is exposed. Federation is exposed when a specific graph may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of graphs appears as a single graph.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTopologyTraversal

      boolean supportsTopologyTraversal()
      Tests if traversing topologies is supported.
      Returns:
      true if topology traversal is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTopologyRouting

      boolean supportsTopologyRouting()
      Tests if topology routing is supported.
      Returns:
      true if topology routing is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsNodeLookup

      boolean supportsNodeLookup()
      Tests if looking up nodes is supported.
      Returns:
      true if node lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsNodeQuery

      boolean supportsNodeQuery()
      Tests if querying nodes is supported.
      Returns:
      true if node query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsNodeSearch

      boolean supportsNodeSearch()
      Tests if searching nodes is supported.
      Returns:
      true if node search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsNodeAdmin

      boolean supportsNodeAdmin()
      Tests if node administrative service is supported.
      Returns:
      true if node administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsNodeNotification

      boolean supportsNodeNotification()
      Tests if a node notification service is supported.
      Returns:
      true if node notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsNodeGraph

      boolean supportsNodeGraph()
      Tests if a node graph mapping lookup service is supported.
      Returns:
      true if a node graph lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsNodeGraphAssignment

      boolean supportsNodeGraphAssignment()
      Tests if a node graph mapping service is supported.
      Returns:
      true if node to graph mapping service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsNodeSmartGraph

      boolean supportsNodeSmartGraph()
      Tests if a node smart graph cataloging service is supported.
      Returns:
      true if node smart graphs are supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEdgeLookup

      boolean supportsEdgeLookup()
      Tests if looking up edges is supported.
      Returns:
      true if edge lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEdgeSearch

      boolean supportsEdgeSearch()
      Tests if searching edges is supported.
      Returns:
      true if edge search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEdgeAdmin

      boolean supportsEdgeAdmin()
      Tests if edge administrative service is supported.
      Returns:
      true if edge administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEdgeNotification

      boolean supportsEdgeNotification()
      Tests if an edge notification service is supported.
      Returns:
      true if edge notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEdgeGraph

      boolean supportsEdgeGraph()
      Tests if an edge graph mapping lookup service is supported.
      Returns:
      true if an edge graph lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEdgeGraphAssignment

      boolean supportsEdgeGraphAssignment()
      Tests if an edge graph mapping service is supported.
      Returns:
      true if edge to graph mapping service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEdgeSmartGraph

      boolean supportsEdgeSmartGraph()
      Tests if an edgesmart graph cataloging service is supported.
      Returns:
      true if edge smart graphs are supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsGraphLookup

      boolean supportsGraphLookup()
      Tests if looking up graphs is supported.
      Returns:
      true if graph lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsGraphQuery

      boolean supportsGraphQuery()
      Tests if querying graphs is supported.
      Returns:
      true if graph query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsGraphSearch

      boolean supportsGraphSearch()
      Tests if searching graphs is supported.
      Returns:
      true if graph search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsGraphAdmin

      boolean supportsGraphAdmin()
      Tests if graph administrative service is supported.
      Returns:
      true if graph administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsGraphNotification

      boolean supportsGraphNotification()
      Tests if a graph notification service is supported.
      Returns:
      true if graph notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsGraphHierarchy

      boolean supportsGraphHierarchy()
      Tests for the availability of a graph hierarchy traversal service.
      Returns:
      true if graph hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsGraphHierarchyDesign

      boolean supportsGraphHierarchyDesign()
      Tests for the availability of a graph hierarchy design service.
      Returns:
      true if graph hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTopologyBatch

      boolean supportsTopologyBatch()
      Tests for the availability of a topology pbatchath service.
      Returns:
      true if a topology batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTopologyPath

      boolean supportsTopologyPath()
      Tests for the availability of a topology path service.
      Returns:
      true if a topology path service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTopologyRules

      boolean supportsTopologyRules()
      Tests for the availability of a topology rules service.
      Returns:
      true if a topology rules service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getNodeRecordTypes

      TypeList getNodeRecordTypes()
      Gets the supported Node record types.
      Returns:
      a list containing the supported Node record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsNodeRecordType

      boolean supportsNodeRecordType(Type nodeRecordType)
      Tests if the given Node record type is supported.
      Parameters:
      nodeRecordType - a Type indicating a Node record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - nodeRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getNodeSearchRecordTypes

      TypeList getNodeSearchRecordTypes()
      Gets the supported Node search types.
      Returns:
      a list containing the supported Node search types
      Compliance:
      mandatory - This method must be implemented.

    • supportsNodeSearchRecordType

      boolean supportsNodeSearchRecordType(Type nodeSearchRecordType)
      Tests if the given Node search type is supported.
      Parameters:
      nodeSearchRecordType - a Type indicating a Node search type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - nodeSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getEdgeRecordTypes

      TypeList getEdgeRecordTypes()
      Gets the supported Edge record types.
      Returns:
      a list containing the supported Edge record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsEdgeRecordType

      boolean supportsEdgeRecordType(Type edgeRecordType)
      Tests if the given Edge record type is supported.
      Parameters:
      edgeRecordType - a Type indicating an Edge record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - edgeRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getEdgeSearchRecordTypes

      TypeList getEdgeSearchRecordTypes()
      Gets the supported Edge search record types.
      Returns:
      a list containing the supported Edge search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsEdgeSearchRecordType

      boolean supportsEdgeSearchRecordType(Type edgeSearchRecordType)
      Tests if the given Edge search record type is supported.
      Parameters:
      edgeSearchRecordType - a Type indicating an Edge search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - edgeSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getGraphRecordTypes

      TypeList getGraphRecordTypes()
      Gets the supported Graph record types.
      Returns:
      a list containing the supported Graph types
      Compliance:
      mandatory - This method must be implemented.

    • supportsGraphRecordType

      boolean supportsGraphRecordType(Type graphRecordType)
      Tests if the given Graph record type is supported.
      Parameters:
      graphRecordType - a Type indicating a Graph record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - graphRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getGraphSearchRecordTypes

      TypeList getGraphSearchRecordTypes()
      Gets the supported Graph search record types.
      Returns:
      a list containing the supported Graph search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsGraphSearchRecordType

      boolean supportsGraphSearchRecordType(Type graphSearchRecordType)
      Tests if the given Graph search record type is supported.
      Parameters:
      graphSearchRecordType - a Type indicating a Graph search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - graphSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.