Interface MapSearchSession

All Superinterfaces:

AutoCloseable, Closeable, MapQuerySession, OsidSession, OsidSession

public interface MapSearchSession
extends MapQuerySession

This session provides methods for searching among Maps . 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface MapQuerySession

canSearchMaps, getMapQuery, getMapsByQuery

Modifier and Type	Method	Description
boolean	canSearchMaps()	Tests if this user can perform Map searches.
MapQuery	getMapQuery()	Gets a map query.
MapList	getMapsByQuery(MapQuery mapQuery)	Gets a list of Maps matching the given map query.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.