OSID Logo
OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.NodeSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetNodes
Description

Gets the node list resulting from a search.

Returnosid.topology.NodeListthe node list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetNodeQueryInspector
Description

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

Returnosid.topology.NodeQueryInspectorthe node query inspector
CompliancemandatoryThis 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.TypenodeSearchRecordTypea node search record type
Returnosid.topology.records.NodeSearchResultsRecordthe node search results record
ErrorsNULL_ARGUMENT nodeSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(nodeSearchRecordType) is false
CompliancemandatoryThis method must be implemented.