org.osid.topology

Interface EdgeSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, EdgeQuerySession, 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

Methods

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

canSearchEdges, getEdgeQuery, getEdgesByQuery, getGraph, getGraphId, 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

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.