Interface | osid.topology.NodeSearchSession | ||
---|---|---|---|
Implements | osid.topology.NodeQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Nodes may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getNodeSearch | ||
Description |
Gets a node search. | ||
Return | osid.topology.NodeSearch | the node search | |
Compliance | mandatory | This method must be implemented. | |
Method | getNodeSearchOrder | ||
Description |
Gets a node search order. The | ||
Return | osid.topology.NodeSearchOrder | the node search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getNodesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.topology.NodeQuery | nodeQuery | the node query |
osid.topology.NodeSearch | nodeSearch | the node search | |
Return | osid.topology.NodeSearchResults | the node search results | |
Errors | NULL_ARGUMENT | nodeQuery or nodeSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | nodeQuery or nodeSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getNodeQueryFromInspector | ||
Description |
Gets a node query from an inspector. The inspector is
available from a | ||
Parameters | osid.topology.NodeQueryInspector | nodeQueryInspector | a node query inspector |
Return | osid.topology.NodeQuery | the node query | |
Errors | NULL_ARGUMENT | nodeQueryInspector is null | |
UNSUPPORTED | nodeQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |