OSID Specifications
topology path package
Version 3.0.0
topology path package
Version 3.0.0
| Interface | osid.topology.path.TopologyPathProfile | ||
|---|---|---|---|
| Implements | osid.OsidProfile | ||
| Implemented By | osid.topology.path.TopologyPathManager | ||
osid.topology.path.TopologyPathProxyManager | |||
| Description |
The topology profile describes the interoperability among topology path 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 | supportsPathLookup | ||
| Description |
Tests if looking up paths is supported. | ||
| Return | boolean | true if path lookup is supported, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPathQuery | ||
| Description |
Tests if querying paths is supported. | ||
| Return | boolean | true if path query is supported, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPathSearch | ||
| Description |
Tests if searching paths is supported. | ||
| Return | boolean | true if path search is supported, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPathAdmin | ||
| Description |
Tests if path administrative service is supported. | ||
| Return | boolean | true if path administration is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPathNotification | ||
| Description |
Tests if a path notification service is supported. | ||
| Return | boolean | true if path notification is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPathGraph | ||
| Description |
Tests if a path graph lookup service is supported. | ||
| Return | boolean | true if a path graph lookup service is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPathGraphAssignment | ||
| Description |
Tests if a path graph service is supported. | ||
| Return | boolean | true if path to graph assignment service is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPathSmartGraph | ||
| Description |
Tests if a path smart graph lookup service is supported. | ||
| Return | boolean | true if a path smart graph service is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPathRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported Path record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPathRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | pathRecordType | a Type indicating a Path record type |
| Return | boolean | true if the given record type is supported, false
otherwise | |
| Errors | NULL_ARGUMENT | pathRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPathSearchRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported Path search types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPathSearchRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | pathSearchRecordType | a Type indicating a Path search type |
| Return | boolean | true if the given Type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | pathSearchRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |