OSID Logo
OSID Specifications
mapping path package
Version 3.1.0
Interfaceosid.mapping.path.IntersectionSearchResults
Implementsosid.OsidSearchResults
Used Byosid.mapping.path.IntersectionSearchSession
Description

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

MethodgetIntersections
Description

Gets the intersection list resulting from a search.

Returnosid.mapping.path.IntersectionList the intersection list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetIntersectionQueryInspector
Description

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

Returnosid.mapping.path.IntersectionQueryInspector the intersection query inspector
Compliancemandatory This method must be implemented.
MethodgetIntersectionSearchResultsRecord
Description

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

Parametersosid.type.TypeintersectionSearchRecordType a intersection search record type
Returnosid.mapping.path.records.IntersectionSearchResultsRecord the intersection search results record
ErrorsNULL_ARGUMENT intersectionSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(intersectionSearchRecordType) is false
Compliancemandatory This method must be implemented.