Interface LocationSearchSession

All Superinterfaces:

AutoCloseable, Closeable, LocationQuerySession, OsidSession, OsidSession

public interface LocationSearchSession
extends LocationQuerySession

This session provides methods for searching among Locations . The search query is constructed using the LocationQuery .

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

This session defines views that offer differing behaviors for searching.

• federated map view: searches include locations in maps of which this map is an ancestor in the map hierarchy
• isolated map view: searches are restricted to locations in this map

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

Method Summary

Modifier and Type	Method	Description
LocationQuery	getLocationQueryFromInspector(LocationQueryInspector locationQueryInspector)	Gets a location query from an inspector.
LocationSearchResults	getLocationsBySearch(LocationQuery locationQuery, LocationSearch locationSearch)	Gets the search results matching the given search query using the given search.
LocationSearch	getLocationSearch()	Gets a location search.
LocationSearchOrder	getLocationSearchOrder()	Gets a location search order.

Methods inherited from interface Closeable

close

Methods inherited from interface LocationQuerySession

canSearchLocations, getLocationQuery, getLocationsByQuery, getMap, getMapId, useFederatedMapView, useIsolatedMapView

Modifier and Type	Method	Description
boolean	canSearchLocations()	Tests if this user can perform Location lookups.
LocationQuery	getLocationQuery()	Gets a location query.
LocationList	getLocationsByQuery(LocationQuery locationQuery)	Gets a list of Locations matching the given search.
Map	getMap()	Gets the Map associated with this session.
Id	getMapId()	Gets the Map Id associated with this session.
void	useFederatedMapView()	Federates the view for methods in this session.
void	useIsolatedMapView()	Isolates the view for methods in this session.

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

getLocationSearch

LocationSearch getLocationSearch()

Gets a location search.

Returns:

the location search

Compliance:

mandatory - This method must be implemented.

getLocationSearchOrder

LocationSearchOrder getLocationSearchOrder()

Gets a location search order. The LocationSearchOrder is supplied to a LocationSearch to specify the ordering of results.

Returns:

the location search order

Compliance:

mandatory - This method must be implemented.

getLocationsBySearch

LocationSearchResults getLocationsBySearch(LocationQuery locationQuery,
 LocationSearch locationSearch)
                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

locationQuery - the location query

locationSearch - the location search

Returns:

the returned search results

Throws:

NullArgumentException - locationQuery or locationSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - locationQuery or locationSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getLocationQueryFromInspector

LocationQuery getLocationQueryFromInspector(LocationQueryInspector locationQueryInspector)

Gets a location query from an inspector. The inspector is available from a LocationSearchResults .

Parameters:

locationQueryInspector - a location query inspector

Returns:

the location query

Throws:

NullArgumentException - locationQueryInspector is null

UnsupportedException - locationQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.