OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.IntersectionSearchResults
Implementsosid.OsidSearchResults
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.IntersectionListthe intersection list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionQueryInspector
Description

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

Returnosid.mapping.path.IntersectionQueryInspectorthe intersection query inspector
CompliancemandatoryThis 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.TypeintersectionSearchRecordTypea intersection search record type
Returnosid.mapping.path.records.IntersectionSearchResultsRecordthe intersection search results record
ErrorsNULL_ARGUMENT intersectionSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(intersectionSearchRecordType) is false
CompliancemandatoryThis method must be implemented.