OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.IntersectionSearch
Implementsosid.OsidSearch
Description

The search interface for governing intersection searches.

MethodsearchAmongIntersections
Description

Execute this search among the given list of intersections.

Parametersosid.id.IdListintersectionIdslist of intersections
ErrorsNULL_ARGUMENT intersectionIds is null
CompliancemandatoryThis method must be implemented.
MethodorderIntersectionResults
Description

Specify an ordering to the search results.

Parametersosid.mapping.path.IntersectionSearchOrderintersectionSearchOrderintersection search order
ErrorsNULL_ARGUMENT intersectionSearchOrder is null
UNSUPPORTED intersectionSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionSearchRecord
Description

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