OSID Logo
OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.NodeSearch
Implementsosid.OsidSearch
Description

The search interface for governing node searches.

MethodsearchAmongNodes
Description

Execute this search among the given list of nodes.

Parametersosid.id.IdListnodeIdslist of nodes
ErrorsNULL_ARGUMENT nodeIds is null
CompliancemandatoryThis method must be implemented.
MethodorderNodeResults
Description

Specify an ordering to the search results.

Parametersosid.topology.NodeSearchOrdernodeSearchOrdernode search order
ErrorsNULL_ARGUMENT nodeSearchOrder is null
UNSUPPORTED nodeSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetNodeSearchRecord
Description

Gets the node search 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.NodeSearchRecordthe node search record
ErrorsNULL_ARGUMENT nodeSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(nodeSearchRecordType) is false
CompliancemandatoryThis method must be implemented.