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

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

MethodgetGraphs
Description

Gets the graph list resulting from a search.

Returnosid.topology.GraphListthe graph list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetGraphQueryInspector
Description

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

Returnosid.topology.GraphQueryInspectorthe graph query inspector
CompliancemandatoryThis method must be implemented.
MethodgetGraphSearchResultsRecord
Description

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