org.osid.mapping

Interface LocationSearchSession

All Superinterfaces:

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

public interface LocationSearchSession
extends LocationQuerySession

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

Methods

Modifier and Type	Method and 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 org.osid.mapping.LocationQuerySession

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

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

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.