Interface EdgeSearchSession

All Superinterfaces:

AutoCloseable, Closeable, EdgeQuerySession, OsidSession, OsidSession

public interface EdgeSearchSession
extends EdgeQuerySession

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

getEdgesByQuery() is the basic search method and returns a list of Edges . A more advanced search may be performed with getEdgesBySearch() . It accepts an EdgeSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getEdgesBySearch() returns an EdgesSearchResults that can be used to access the resulting EdgeList or be used to perform a search within the result set through EdgeSearch .

This session defines views that offer differing behaviors for searching.

• federated graph view: searches include edges in graphs of which this graph is an ancestor in the graph hierarchy
• isolated graph view: searches are restricted to edges in this graph

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

Method Summary

Modifier and Type	Method	Description
EdgeQuery	getEdgeQueryFromInspector(EdgeQueryInspector edgeQueryInspector)	Gets an edge query from an inspector.
EdgeSearchResults	getEdgesBySearch(EdgeQuery edgeQuery, EdgeSearch edgeSearch)	Gets the search results matching the given search query using the given search.
EdgeSearch	getEdgeSearch()	Gets an edge search.
EdgeSearchOrder	getEdgeSearchOrder()	Gets an edge search order.

Methods inherited from interface Closeable

close

Methods inherited from interface EdgeQuerySession

canSearchEdges, getEdgeQuery, getEdgesByQuery, getGraph, getGraphId, useFederatedGraphView, useIsolatedGraphView

Modifier and Type	Method	Description
boolean	canSearchEdges()	Tests if this user can perform Edge lookups.
EdgeQuery	getEdgeQuery()	Gets an edge query.
EdgeList	getEdgesByQuery(EdgeQuery edgeQuery)	Gets a list of Edges matching the given edge query.
Graph	getGraph()	Gets the Graph associated with this session.
Id	getGraphId()	Gets the Graph Id associated with this session.
void	useFederatedGraphView()	Federates the view for methods in this session.
void	useIsolatedGraphView()	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

getEdgeSearch

EdgeSearch getEdgeSearch()

Gets an edge search.

Returns:

the edge search

Compliance:

mandatory - This method must be implemented.

getEdgeSearchOrder

EdgeSearchOrder getEdgeSearchOrder()

Gets an edge search order. The EdgeSearchOrder is supplied to an EdgeSearch to specify the ordering of results.

Returns:

the edge search order

Compliance:

mandatory - This method must be implemented.

getEdgesBySearch

EdgeSearchResults getEdgesBySearch(EdgeQuery edgeQuery,
 EdgeSearch edgeSearch)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

edgeQuery - the edge query

edgeSearch - the edge search

Returns:

the edge search results

Throws:

NullArgumentException - edgeQuery or edgeSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - edgeQuery or edgeSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getEdgeQueryFromInspector

EdgeQuery getEdgeQueryFromInspector(EdgeQueryInspector edgeQueryInspector)

Gets an edge query from an inspector. The inspector is available from an EdgeSearchResults .

Parameters:

edgeQueryInspector - an edge query inspector

Returns:

the edge query

Throws:

NullArgumentException - edgeQueryInspector is null

UnsupportedException - edgeQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.