org.osid.topology

Interface GraphSearchSession

All Superinterfaces:

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

public interface GraphSearchSession
extends GraphQuerySession

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

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

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

Method Summary

Methods

Modifier and Type	Method and Description
GraphQuery	getGraphQueryFromInspector(GraphQueryInspector graphQueryInspector) Gets a graph query from an inspector.
GraphSearchResults	getGraphsBySearch(GraphQuery graphQuery, GraphSearch graphSearch) Gets the search results matching the given search query using the given search.
GraphSearch	getGraphSearch() Gets a graph search.
GraphSearchOrder	getGraphSearchOrder() Gets a graph search order.

Methods inherited from interface org.osid.topology.GraphQuerySession

canSearchGraphs, getGraphQuery, getGraphsByQuery

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

getGraphSearch

GraphSearch getGraphSearch()

Gets a graph search.

Returns:

the graph search

Compliance:

mandatory - This method must be implemented.

getGraphSearchOrder

GraphSearchOrder getGraphSearchOrder()

Gets a graph search order. The GraphSearchOrder is supplied to a GraphSearch to specify the ordering of results.

Returns:

the graph search order

Compliance:

mandatory - This method must be implemented.

getGraphsBySearch

GraphSearchResults getGraphsBySearch(GraphQuery graphQuery,
                                   GraphSearch graphSearch)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

graphQuery - the graph query

graphSearch - the graph search

Returns:

the graph search results

Throws:

NullArgumentException - graphQuery or graphSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - graphQuery or graphSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getGraphQueryFromInspector

GraphQuery getGraphQueryFromInspector(GraphQueryInspector graphQueryInspector)

Gets a graph query from an inspector. The inspector is available from a GraphSearchResults.

Parameters:

graphQueryInspector - a graph query inspector

Returns:

the graph query

Throws:

NullArgumentException - graphQueryInspector is null

UnsupportedException - graphQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.