Interface EdgeEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, EdgeEnablerQuerySession, OsidSession, OsidSession

public interface EdgeEnablerSearchSession
extends EdgeEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
EdgeEnablerQuery	getEdgeEnablerQueryFromInspector(EdgeEnablerQueryInspector edgeEnablerQueryInspector)	Gets an edge enabler query from an inspector.
EdgeEnablerSearchResults	getEdgeEnablersBySearch(EdgeEnablerQuery edgeEnablerQuery, EdgeEnablerSearch edgeEnablerSearch)	Gets the search results matching the given search query using the given search.
EdgeEnablerSearch	getEdgeEnablerSearch()	Gets an edge enabler search.
EdgeEnablerSearchOrder	getEdgeEnablerSearchOrder()	Gets an edge enabler search order.

Methods inherited from interface Closeable

close

Methods inherited from interface EdgeEnablerQuerySession

canSearchEdgeEnablers, getEdgeEnablerQuery, getEdgeEnablersByQuery, getGraph, getGraphId, useFederatedGraphView, useIsolatedGraphView

Modifier and Type	Method	Description
boolean	canSearchEdgeEnablers()	Tests if this user can perform EdgeEnabler lookups.
EdgeEnablerQuery	getEdgeEnablerQuery()	Gets an edge enabler query.
EdgeEnablerList	getEdgeEnablersByQuery(EdgeEnablerQuery edgeEnablerQuery)	Gets a list of EdgeEnablers matching the given edge enabler 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

getEdgeEnablerSearch

EdgeEnablerSearch getEdgeEnablerSearch()

Gets an edge enabler search.

Returns:

the edge enabler search

Compliance:

mandatory - This method must be implemented.

getEdgeEnablerSearchOrder

EdgeEnablerSearchOrder getEdgeEnablerSearchOrder()

Gets an edge enabler search order. The EdgeEnablerSearchOrder is supplied to an EdgeEnablerSearch to specify the ordering of results.

Returns:

the edge enabler search order

Compliance:

mandatory - This method must be implemented.

getEdgeEnablersBySearch

EdgeEnablerSearchResults getEdgeEnablersBySearch(EdgeEnablerQuery edgeEnablerQuery,
 EdgeEnablerSearch edgeEnablerSearch)
                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

edgeEnablerQuery - the edge enabler query

edgeEnablerSearch - the edge enabler search

Returns:

the returned search results

Throws:

NullArgumentException - edgeEnablerQuery or edgeEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - edgeEnablerQuery or edgeEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getEdgeEnablerQueryFromInspector

EdgeEnablerQuery getEdgeEnablerQueryFromInspector(EdgeEnablerQueryInspector edgeEnablerQueryInspector)

Gets an edge enabler query from an inspector. The inspector is available from an EdgeEnablerSearchResults .

Parameters:

edgeEnablerQueryInspector - an edge enabler query inspector

Returns:

the edge enabler query

Throws:

NullArgumentException - edgeEnablerQueryInspector is null

UnsupportedException - edgeEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.