Interface PathSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PathQuerySession

public interface PathSearchSession
extends PathQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
PathQuery	getPathQueryFromInspector(PathQueryInspector pathQueryInspector)	Gets a path query from an inspector.
PathSearchResults	getPathsBySearch(PathQuery pathQuery, PathSearch pathSearch)	Gets the search results matching the given search query using the given search.
PathSearch	getPathSearch()	Gets a path search.
PathSearchOrder	getPathSearchOrder()	Gets a path search order.

Methods inherited from interface Closeable

close

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.

Methods inherited from interface PathQuerySession

canSearchPaths, getMap, getMapId, getPathQuery, getPathsByQuery, useFederatedMapView, useIsolatedMapView

Modifier and Type	Method	Description
boolean	canSearchPaths()	Tests if this user can perform Path lookups.
Map	getMap()	Gets the Map associated with this session.
Id	getMapId()	Gets the Map Id associated with this session.
PathQuery	getPathQuery()	Gets a path query.
PathList	getPathsByQuery(PathQuery pathQuery)	Gets a list of Paths matching the given path query.
void	useFederatedMapView()	Federates the view for methods in this session.
void	useIsolatedMapView()	Isolates the view for methods in this session.

Method Details

getPathSearch

PathSearch getPathSearch()

Gets a path search.

Returns:

the path search

Compliance:

mandatory - This method must be implemented.

getPathSearchOrder

PathSearchOrder getPathSearchOrder()

Gets a path search order. The PathSearchOrder is supplied to a PathSearch to specify the ordering of results.

Returns:

the path search order

Compliance:

mandatory - This method must be implemented.

getPathsBySearch

PathSearchResults getPathsBySearch(PathQuery pathQuery,
 PathSearch pathSearch)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

pathQuery - the path query

pathSearch - the path search

Returns:

the returned search results

Throws:

NullArgumentException - pathQuery or pathSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - pathQuery or pathSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPathQueryFromInspector

PathQuery getPathQueryFromInspector(PathQueryInspector pathQueryInspector)

Gets a path query from an inspector. The inspector is available from a PathSearchResults .

Parameters:

pathQueryInspector - a path query inspector

Returns:

the path query

Throws:

NullArgumentException - pathQueryInspector is null

UnsupportedException - pathQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.