OSID Logo
OSID Specifications
mapping route package
Version 3.1.0
Interfaceosid.mapping.route.RouteSearchResults
Implementsosid.OsidSearchResults
Used Byosid.mapping.route.RouteSearchSession
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.RouteList the route list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetRouteQueryInspector
Description

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

Returnosid.mapping.route.RouteQueryInspector the route query inspector
Compliancemandatory This 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.TyperouteSearchRecordType a route search record type
Returnosid.mapping.route.records.RouteSearchResultsRecord the route search results record
ErrorsNULL_ARGUMENT routeSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(routeSearchRecordType) is false
Compliancemandatory This method must be implemented.