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

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

MethodgetEdges
Description

Gets the edge list resulting from a search.

Returnosid.topology.EdgeListthe edge list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetEdgeQueryInspector
Description

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

Returnosid.topology.EdgeQueryInspectorthe edge query inspector
CompliancemandatoryThis method must be implemented.
MethodgetEdgeSearchResultsRecord
Description

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

Parametersosid.type.TypeedgeSearchRecordTypea edge search record type
Returnosid.topology.records.EdgeSearchResultsRecordthe edge search results record
ErrorsNULL_ARGUMENT edgeSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(edgeSearchRecordType) is false
CompliancemandatoryThis method must be implemented.