Interface | osid.topology.path.PathQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Paths may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
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 | canSearchPaths | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedGraphView | ||
Description |
Federates the view for methods in this session. A federated view will include paths in graphs which are children of this graph in the graph hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedGraphView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts searches to this graph only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getPathQuery | ||
Description |
Gets a path query. | ||
Return | osid.topology.path.PathQuery | the path query | |
Compliance | mandatory | This method must be implemented. | |
Method | getPathsByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.topology.path.PathQuery | pathQuery | the path query |
Return | osid.topology.path.PathList | the returned PathList | |
Errors | NULL_ARGUMENT | pathQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | pathQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |