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

The search interface for governing graph searches.

MethodsearchAmongGraphs
Description

Execute this search among the given list of graphs.

Parametersosid.id.IdListgraphIdslist of graphs
ErrorsNULL_ARGUMENT graphIds is null
CompliancemandatoryThis method must be implemented.
MethodorderGraphResults
Description

Specify an ordering to the search results.

Parametersosid.topology.GraphSearchOrdergraphSearchOrdergraph search order
ErrorsNULL_ARGUMENT graphSearchOrder is null
UNSUPPORTED graphSearchOrder is not of this service
CompliancemandatoryThis 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.TypegraphSearchRecordTypea graph search record type
Returnosid.topology.records.GraphSearchRecordthe graph search record
ErrorsNULL_ARGUMENT graphSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(graphSearchRecordType) is false
CompliancemandatoryThis method must be implemented.