OSID Logo
OSID Specifications
topology package
Version 3.1.0
Interfaceosid.topology.GraphSearch
Implementsosid.OsidSearch
Used Byosid.topology.GraphSearchSession
Description

The search interface for governing graph searches.

MethodsearchAmongGraphs
Description

Execute this search among the given list of graphs.

Parametersosid.id.IdListgraphIds list of graphs
ErrorsNULL_ARGUMENT graphIds is null
Compliancemandatory This method must be implemented.
MethodorderGraphResults
Description

Specify an ordering to the search results.

Parametersosid.topology.GraphSearchOrdergraphSearchOrder graph search order
ErrorsNULL_ARGUMENT graphSearchOrder is null
UNSUPPORTED graphSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetGraphSearchRecord
Description

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

Parametersosid.type.TypegraphSearchRecordType a graph search record type
Returnosid.topology.records.GraphSearchRecord the graph search record
ErrorsNULL_ARGUMENT graphSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(graphSearchRecordType) is false
Compliancemandatory This method must be implemented.