Interface | osid.topology.EdgeSmartGraphSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. An This | ||
Method | getGraphId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Graph Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getGraph | ||
Description |
Gets the | ||
Return | osid.topology.Graph | the graph | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartGraphs | ||
Description |
Tests if this user can manage smart graphs. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this
session will result in a | ||
Return | boolean | false if smart graph methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeQuery | ||
Description |
Gets an edge query. | ||
Return | osid.topology.EdgeQuery | the edge query | |
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeSearchOrder | ||
Description |
Gets an edge search order. | ||
Return | osid.topology.EdgeSearchOrder | the edge search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyEdgeQuery | ||
Description |
Applies an edge query to this graph. | ||
Parameters | osid.topology.EdgeQuery | edgeQuery | the edge query |
Errors | NULL_ARGUMENT | edgeQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | edgeQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectEdgeQuery | ||
Description |
Gets an edge query inspector for this graph. | ||
Return | osid.topology.EdgeQueryInspector | the edge query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyEdgeSequencing | ||
Description |
Applies an edge search order to this graph. | ||
Parameters | osid.topology.EdgeSearchOrder | edgeSearchOrder | the edge search order |
Errors | NULL_ARGUMENT | edgeSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | edgeSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeQueryFromInspector | ||
Description |
Gets an edge query from an inspector. | ||
Parameters | osid.topology.EdgeQueryInspector | edgeQueryInspector | an edge query inspector |
Return | osid.topology.EdgeQuery | the edge query | |
Errors | NULL_ARGUMENT | relatinshipQueryInspector is null | |
UNSUPPORTED | edgeQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |