org.osid.topology.path

Interface PathQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

PathSearchSession

public interface PathQuerySession
extends OsidSession

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

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
boolean	canSearchPaths() Tests if this user can perform Path lookups.
Graph	getGraph() Gets the Graph associated with this session.
Id	getGraphId() Gets the Graph 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	useFederatedGraphView() Federates the view for methods in this session.
void	useIsolatedGraphView() Isolates the view for methods in this session.

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

getGraphId

Id getGraphId()

Gets the Graph Id associated with this session.

Returns:

the Graph Id associated with this session

Compliance:

mandatory - This method must be implemented.

getGraph

Graph getGraph()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Graph associated with this session.

Returns:

the graph

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchPaths

boolean canSearchPaths()

Tests if this user can perform Path lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedGraphView

void useFederatedGraphView()

Federates the view for methods in this session. A federated view will include paths in graphs which are children of this graph in the graph hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedGraphView

void useIsolatedGraphView()

Isolates the view for methods in this session. An isolated view restricts searches to this graph only.

Compliance:

mandatory - This method is must be implemented.

getPathQuery

PathQuery getPathQuery()

Gets a path query.

Returns:

the path query

Compliance:

mandatory - This method must be implemented.

getPathsByQuery

PathList getPathsByQuery(PathQuery pathQuery)
                         throws OperationFailedException,
                                PermissionDeniedException

Gets a list of Paths matching the given path query.

Parameters:

pathQuery - the path query

Returns:

the returned PathList

Throws:

NullArgumentException - pathQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - pathQuery is not of this service

Compliance:

mandatory - This method must be implemented.