Interface | osid.topology.EdgeSearchSession | ||
---|---|---|---|
Implements | osid.topology.EdgeQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Edges may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getEdgeSearch | ||
Description |
Gets an edge search. | ||
Return | osid.topology.EdgeSearch | the edge search | |
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeSearchOrder | ||
Description |
Gets an edge search order. The | ||
Return | osid.topology.EdgeSearchOrder | the edge search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getEdgesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.topology.EdgeQuery | edgeQuery | the edge query |
osid.topology.EdgeSearch | edgeSearch | the edge search | |
Return | osid.topology.EdgeSearchResults | the edge search results | |
Errors | NULL_ARGUMENT | edgeQuery or edgeSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | edgeQuery or edgeSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEdgeQueryFromInspector | ||
Description |
Gets an edge query from an inspector. The inspector is
available from an | ||
Parameters | osid.topology.EdgeQueryInspector | edgeQueryInspector | an edge query inspector |
Return | osid.topology.EdgeQuery | the edge query | |
Errors | NULL_ARGUMENT | edgeQueryInspector is null | |
UNSUPPORTED | edgeQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |