OSID Logo
OSID Specifications
topology package
Version 3.1.0
Interfaceosid.topology.NodeSearchResults
Implementsosid.OsidSearchResults
Used Byosid.topology.NodeSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetNodes
Description

Gets the node list resulting from a search.

Returnosid.topology.NodeList the node list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetNodeQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.topology.NodeQueryInspector the node query inspector
Compliancemandatory This method must be implemented.
MethodgetNodeSearchResultsRecord
Description

Gets the node search results record corresponding to the given node search record Type.This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypenodeSearchRecordType a node search record type
Returnosid.topology.records.NodeSearchResultsRecord the node search results record
ErrorsNULL_ARGUMENT nodeSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(nodeSearchRecordType) is false
Compliancemandatory This method must be implemented.