org.osid.topology.path

Interface PathSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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 graph view: searches include paths in graphs of which this graph is an ancestor in the graph hierarchy
• isolated graph view: searches are restricted to paths in this graph

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

Method Summary

Methods

Modifier and Type	Method and 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 org.osid.topology.path.PathQuerySession

canSearchPaths, getGraph, getGraphId, getPathQuery, getPathsByQuery, useFederatedGraphView, useIsolatedGraphView

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

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 path 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.