org.osid.mapping

Interface MapSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface MapSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
MapQueryInspector	getMapQueryInspector() Gets the inspector for the query to examine the terms used in the search.
MapList	getMaps() Gets the map list resulting from a search.
MapSearchResultsRecord	getMapSearchResultsRecord(Type mapSearchRecordType) Gets the map search results record corresponding to the given map 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

getMaps

MapList getMaps()

Gets the map list resulting from a search.

Returns:

the map list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getMapQueryInspector

MapQueryInspector getMapQueryInspector()

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

Returns:

the map query inspector

Compliance:

mandatory - This method must be implemented.

getMapSearchResultsRecord

MapSearchResultsRecord getMapSearchResultsRecord(Type mapSearchRecordType)
                                                 throws OperationFailedException

Gets the map search results record corresponding to the given map search record Type. This method must be used to retrieve an object implementing the requested record interface along with all of its ancestor interfaces.

Parameters:

mapSearchRecordType - a map search record type

Returns:

the map search results record

Throws:

NullArgumentException - mapSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(mapSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.