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

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

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.