OSID Logo
OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.TopologyProfile
Implementsosid.OsidProfile
Description

The topology profile describes the interoperability among topology services.

MethodsupportsVisibleFederation
Description

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.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTopologyTraversal
Description

Tests if traversing topologies is supported.

Returnboolean true if topology traversal is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTopologyRouting
Description

Tests if topology routing is supported.

Returnboolean true if topology routing is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsNodeLookup
Description

Tests if looking up nodes is supported.

Returnboolean true if node lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsNodeQuery
Description

Tests if querying nodes is supported.

Returnboolean true if node query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsNodeSearch
Description

Tests if searching nodes is supported.

Returnboolean true if node search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsNodeAdmin
Description

Tests if node administrative service is supported.

Returnboolean true if node administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsNodeNotification
Description

Tests if a node notification service is supported.

Returnboolean true if node notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsNodeGraph
Description

Tests if a node graph mapping lookup service is supported.

Returnboolean true if a node graph lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsNodeGraphAssignment
Description

Tests if a node graph mapping service is supported.

Returnboolean true if node to graph mapping service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsNodeSmartGraph
Description

Tests if a node smart graph cataloging service is supported.

Returnboolean true if node smart graphs are supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEdgeLookup
Description

Tests if looking up edges is supported.

Returnboolean true if edge lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEdgeSearch
Description

Tests if searching edges is supported.

Returnboolean true if edge search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEdgeAdmin
Description

Tests if edge administrative service is supported.

Returnboolean true if edge administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEdgeNotification
Description

Tests if an edge notification service is supported.

Returnboolean true if edge notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEdgeGraph
Description

Tests if an edge graph mapping lookup service is supported.

Returnboolean true if an edge graph lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEdgeGraphAssignment
Description

Tests if an edge graph mapping service is supported.

Returnboolean true if edge to graph mapping service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEdgeSmartGraph
Description

Tests if an edgesmart graph cataloging service is supported.

Returnboolean true if edge smart graphs are supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsGraphLookup
Description

Tests if looking up graphs is supported.

Returnboolean true if graph lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsGraphQuery
Description

Tests if querying graphs is supported.

Returnboolean true if graph query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsGraphSearch
Description

Tests if searching graphs is supported.

Returnboolean true if graph search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsGraphAdmin
Description

Tests if graph administrative service is supported.

Returnboolean true if graph administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsGraphNotification
Description

Tests if a graph notification service is supported.

Returnboolean true if graph notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsGraphHierarchy
Description

Tests for the availability of a graph hierarchy traversal service.

Returnboolean true if graph hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsGraphHierarchyDesign
Description

Tests for the availability of a graph hierarchy design service.

Returnboolean true if graph hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTopologyBatch
Description

Tests for the availability of a topology pbatchath service.

Returnboolean true if a topology batch service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTopologyPath
Description

Tests for the availability of a topology path service.

Returnboolean true if a topology path service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTopologyRules
Description

Tests for the availability of a topology rules service.

Returnboolean true if a topology rules service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetNodeRecordTypes
Description

Gets the supported Node record types.

Returnosid.type.TypeLista list containing the supported Node record types
CompliancemandatoryThis method must be implemented.
MethodsupportsNodeRecordType
Description

Tests if the given Node record type is supported.

Parametersosid.type.TypenodeRecordTypea Type indicating a Node record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT nodeRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetNodeSearchRecordTypes
Description

Gets the supported Node search types.

Returnosid.type.TypeLista list containing the supported Node search types
CompliancemandatoryThis method must be implemented.
MethodsupportsNodeSearchRecordType
Description

Tests if the given Node search type is supported.

Parametersosid.type.TypenodeSearchRecordTypea Type indicating a Node search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT nodeSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetEdgeRecordTypes
Description

Gets the supported Edge record types.

Returnosid.type.TypeLista list containing the supported Edge record types
CompliancemandatoryThis method must be implemented.
MethodsupportsEdgeRecordType
Description

Tests if the given Edge record type is supported.

Parametersosid.type.TypeedgeRecordTypea Type indicating an Edge record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT edgeRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetEdgeSearchRecordTypes
Description

Gets the supported Edge search record types.

Returnosid.type.TypeLista list containing the supported Edge search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsEdgeSearchRecordType
Description

Tests if the given Edge search record type is supported.

Parametersosid.type.TypeedgeSearchRecordTypea Type indicating an Edge search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT edgeSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetGraphRecordTypes
Description

Gets the supported Graph record types.

Returnosid.type.TypeLista list containing the supported Graph types
CompliancemandatoryThis method must be implemented.
MethodsupportsGraphRecordType
Description

Tests if the given Graph record type is supported.

Parametersosid.type.TypegraphRecordTypea Type indicating a Graph record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT graphRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetGraphSearchRecordTypes
Description

Gets the supported Graph search record types.

Returnosid.type.TypeLista list containing the supported Graph search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsGraphSearchRecordType
Description

Tests if the given Graph search record type is supported.

Parametersosid.type.TypegraphSearchRecordTypea Type indicating a Graph search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT graphSearchRecordType is null
CompliancemandatoryThis method must be implemented.