org.osid.mapping

Interface MapSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, MapQuerySession, OsidSession

public interface MapSearchSession
extends MapQuerySession

This session provides methods for searching among Map objects. The search query is constructed using the MapQuery.

getMapsByQuery() is the basic search method and returns a list of Maps. A more advanced search may be performed with getMapsBySearch(). It accepts a MapSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getMapsBySearch() returns a MapSearchResults that can be used to access the resulting MapList or be used to perform a search within the result set through MapSearch.

Maps may have a query record indicated by their respective record types. The query record is accessed via the MapQuery.

Method Summary

Methods

Modifier and Type	Method and Description
MapQuery	getMapQueryFromInspector(MapQueryInspector mapQueryInspector) Gets a map query from an inspector.
MapSearchResults	getMapsBySearch(MapQuery mapQuery, MapSearch mapSearch) Gets the search results matching the given search query using the given search.
MapSearch	getMapSearch() Gets a map search.
MapSearchOrder	getMapSearchOrder() Gets a map search order.

Methods inherited from interface org.osid.mapping.MapQuerySession

canSearchMaps, getMapQuery, getMapsByQuery

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getMapSearch

MapSearch getMapSearch()

Gets a map search.

Returns:

the map search

Compliance:

mandatory - This method must be implemented.

getMapSearchOrder

MapSearchOrder getMapSearchOrder()

Gets a map search order. The MapSearchOrder is supplied to a MapSearch to specify the ordering of results.

Returns:

the map search order

Compliance:

mandatory - This method must be implemented.

getMapsBySearch

MapSearchResults getMapsBySearch(MapQuery mapQuery,
                               MapSearch mapSearch)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

mapQuery - the map query

mapSearch - the map search

Returns:

the returned search results

Throws:

NullArgumentException - mapQuery or mapSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - mapQuery or mapSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getMapQueryFromInspector

MapQuery getMapQueryFromInspector(MapQueryInspector mapQueryInspector)

Gets a map query from an inspector. The inspector is available from a MapSearchResults.

Parameters:

mapQueryInspector - a map query inspector

Returns:

the map query

Throws:

NullArgumentException - mapQueryInspector is null

UnsupportedException - mapQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.