OSID Logo
OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.NodeSearchSession
Implementsosid.topology.NodeQuerySession
Description

This session provides methods for searching among Node objects. The search query is constructed using the NodeQuery.

getNodesByQuery() is the basic search method and returns a list of Nodes. A more advanced search may be performed with getNodesBySearch(). It accepts a NodeSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getNodesBySearch() returns a NodeSearchResults that can be used to access the resulting NodeList or be used to perform a search within the result set through NodeSearch.

This session defines views that offer differing behaviors for searching.

  • federated graph view: searches include nodes in graphs of which this graph is an ancestor in the graph hierarchy
  • isolated graph view: searches are restricted to nodes in this graph

Nodes may have a query record indicated by their respective record types. The query record is accessed via the NodeQuery.

MethodgetNodeSearch
Description

Gets a node search.

Returnosid.topology.NodeSearchthe node search
CompliancemandatoryThis method must be implemented.
MethodgetNodeSearchOrder
Description

Gets a node search order. The NodeSearchOrder is supplied to a NodeSearch to specify the ordering of results.

Returnosid.topology.NodeSearchOrderthe node search order
CompliancemandatoryThis method must be implemented.
MethodgetNodesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.topology.NodeQuerynodeQuerythe node query
osid.topology.NodeSearchnodeSearchthe node search
Returnosid.topology.NodeSearchResultsthe node search results
ErrorsNULL_ARGUMENT nodeQuery or nodeSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED nodeQuery or nodeSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetNodeQueryFromInspector
Description

Gets a node query from an inspector. The inspector is available from a NodeSearchResults.

Parametersosid.topology.NodeQueryInspectornodeQueryInspectora node query inspector
Returnosid.topology.NodeQuerythe node query
ErrorsNULL_ARGUMENT nodeQueryInspector is null
UNSUPPORTED nodeQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.