OSID - osid.topology.TopologyProfile Service Interface Definition

Interface	osid.topology.TopologyProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.topology.TopologyManager`
Implemented By	`osid.topology.TopologyProxyManager`
Description	The topology profile describes the interoperability among topology services.
Method	supportsVisibleFederation
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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTopologyTraversal
Description	Tests if traversing topologies is supported.
Return	`boolean`		`true` if topology traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTopologyRouting
Description	Tests if topology routing is supported.
Return	`boolean`		`true` if topology routing is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsNodeLookup
Description	Tests if looking up nodes is supported.
Return	`boolean`		`true` if node lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsNodeQuery
Description	Tests if querying nodes is supported.
Return	`boolean`		`true` if node query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsNodeSearch
Description	Tests if searching nodes is supported.
Return	`boolean`		`true` if node search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsNodeAdmin
Description	Tests if node administrative service is supported.
Return	`boolean`		`true` if node administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsNodeNotification
Description	Tests if a node notification service is supported.
Return	`boolean`		`true` if node notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsNodeGraph
Description	Tests if a node graph mapping lookup service is supported.
Return	`boolean`		`true` if a node graph lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsNodeGraphAssignment
Description	Tests if a node graph mapping service is supported.
Return	`boolean`		`true` if node to graph mapping service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsNodeSmartGraph
Description	Tests if a node smart graph cataloging service is supported.
Return	`boolean`		`true` if node smart graphs are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEdgeLookup
Description	Tests if looking up edges is supported.
Return	`boolean`		`true` if edge lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEdgeSearch
Description	Tests if searching edges is supported.
Return	`boolean`		`true` if edge search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEdgeAdmin
Description	Tests if edge administrative service is supported.
Return	`boolean`		`true` if edge administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEdgeNotification
Description	Tests if an edge notification service is supported.
Return	`boolean`		`true` if edge notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEdgeGraph
Description	Tests if an edge graph mapping lookup service is supported.
Return	`boolean`		`true` if an edge graph lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEdgeGraphAssignment
Description	Tests if an edge graph mapping service is supported.
Return	`boolean`		`true` if edge to graph mapping service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEdgeSmartGraph
Description	Tests if an edgesmart graph cataloging service is supported.
Return	`boolean`		`true` if edge smart graphs are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGraphLookup
Description	Tests if looking up graphs is supported.
Return	`boolean`		`true` if graph lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGraphQuery
Description	Tests if querying graphs is supported.
Return	`boolean`		`true` if graph query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGraphSearch
Description	Tests if searching graphs is supported.
Return	`boolean`		`true` if graph search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGraphAdmin
Description	Tests if graph administrative service is supported.
Return	`boolean`		`true` if graph administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGraphNotification
Description	Tests if a graph notification service is supported.
Return	`boolean`		`true` if graph notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGraphHierarchy
Description	Tests for the availability of a graph hierarchy traversal service.
Return	`boolean`		`true` if graph hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsGraphHierarchyDesign
Description	Tests for the availability of a graph hierarchy design service.
Return	`boolean`		`true` if graph hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTopologyBatch
Description	Tests for the availability of a topology pbatchath service.
Return	`boolean`		`true` if a topology batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTopologyPath
Description	Tests for the availability of a topology path service.
Return	`boolean`		`true` if a topology path service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTopologyRules
Description	Tests for the availability of a topology rules service.
Return	`boolean`		`true` if a topology rules service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getNodeRecordTypes
Description	Gets the supported `Node` record types.
Return	`osid.type.TypeList`		a list containing the supported `Node` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsNodeRecordType
Description	Tests if the given `Node` record type is supported.
Parameters	`osid.type.Type`	`nodeRecordType`	a `Type` indicating a `Node` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`nodeRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getNodeSearchRecordTypes
Description	Gets the supported `Node` search types.
Return	`osid.type.TypeList`		a list containing the supported `Node` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsNodeSearchRecordType
Description	Tests if the given `Node` search type is supported.
Parameters	`osid.type.Type`	`nodeSearchRecordType`	a `Type` indicating a `Node` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`nodeSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeRecordTypes
Description	Gets the supported `Edge` record types.
Return	`osid.type.TypeList`		a list containing the supported `Edge` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEdgeRecordType
Description	Tests if the given `Edge` record type is supported.
Parameters	`osid.type.Type`	`edgeRecordType`	a `Type` indicating an `Edge` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`edgeRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEdgeSearchRecordTypes
Description	Gets the supported `Edge` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Edge` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEdgeSearchRecordType
Description	Tests if the given `Edge` search record type is supported.
Parameters	`osid.type.Type`	`edgeSearchRecordType`	a `Type` indicating an `Edge` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`edgeSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGraphRecordTypes
Description	Gets the supported `Graph` record types.
Return	`osid.type.TypeList`		a list containing the supported `Graph` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsGraphRecordType
Description	Tests if the given `Graph` record type is supported.
Parameters	`osid.type.Type`	`graphRecordType`	a `Type` indicating a `Graph` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`graphRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGraphSearchRecordTypes
Description	Gets the supported `Graph` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Graph` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsGraphSearchRecordType
Description	Tests if the given `Graph` search record type is supported.
Parameters	`osid.type.Type`	`graphSearchRecordType`	a `Type` indicating a `Graph` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`graphSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.