OSID Logo
OSID Specifications
mapping route package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.route.RouteSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetRoutes
Description

Gets the route list resulting from a search.

Returnosid.mapping.route.RouteListthe route list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRouteQueryInspector
Description

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

Returnosid.mapping.route.RouteQueryInspectorthe route query inspector
CompliancemandatoryThis method must be implemented.
MethodgetRouteSearchResultsRecord
Description

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

Parametersosid.type.TyperouteSearchRecordTypea route search record type
Returnosid.mapping.route.records.RouteSearchResultsRecordthe route search results record
ErrorsNULL_ARGUMENT routeSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(routeSearchRecordType) is false
CompliancemandatoryThis method must be implemented.