org.osid.mapping.route

Interface RouteSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RouteSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
RouteQueryInspector	getRouteQueryInspector() Gets the inspector for the query to examine the terms used in the search.
RouteList	getRoutes() Gets the route list resulting from a search.
RouteSearchResultsRecord	getRouteSearchResultsRecord(Type routeSearchRecordType) Gets the route search results record corresponding to the given route search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getRoutes

RouteList getRoutes()

Gets the route list resulting from a search.

Returns:

the route list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getRouteQueryInspector

RouteQueryInspector getRouteQueryInspector()

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

Returns:

the route query inspector

Compliance:

mandatory - This method must be implemented.

getRouteSearchResultsRecord

RouteSearchResultsRecord getRouteSearchResultsRecord(Type routeSearchRecordType)
                                                     throws OperationFailedException

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.

Parameters:

routeSearchRecordType - a route search record type

Returns:

the route search results record

Throws:

NullArgumentException - routeSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(routeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.