OSID Logo
OSID Specifications
topology package
Version 3.1.0
Interfaceosid.topology.NodeSearch
Implementsosid.OsidSearch
Used Byosid.topology.NodeSearchSession
Description

The search interface for governing node searches.

MethodsearchAmongNodes
Description

Execute this search among the given list of nodes.

Parametersosid.id.IdListnodeIds list of nodes
ErrorsNULL_ARGUMENT nodeIds is null
Compliancemandatory This method must be implemented.
MethodorderNodeResults
Description

Specify an ordering to the search results.

Parametersosid.topology.NodeSearchOrdernodeSearchOrder node search order
ErrorsNULL_ARGUMENT nodeSearchOrder is null
UNSUPPORTED nodeSearchOrder is not of this service
Compliancemandatory This 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.TypenodeSearchRecordType a node search record type
Returnosid.topology.records.NodeSearchRecord the node search record
ErrorsNULL_ARGUMENT nodeSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(nodeSearchRecordType) is false
Compliancemandatory This method must be implemented.