org.osid.mapping.path

Interface SignalSearchSession

All Superinterfaces:

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

public interface SignalSearchSession
extends SignalQuerySession

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

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

This session defines views that offer differing behaviors for searching.

• federated map view: searches include signals in maps of which this map is an ancestor in the map hierarchy
• isolated map view: searches are restricted to signals in this map

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

Method Summary

Methods

Modifier and Type	Method and Description
SignalQuery	getSignalQueryFromInspector(SignalQueryInspector signalQueryInspector) Gets a signal query from an inspector.
SignalSearchResults	getSignalsBySearch(SignalQuery signalQuery, SignalSearch signalSearch) Gets the search results matching the given search query using the given search.
SignalSearch	getSignalSearch() Gets a signal search.
SignalSearchOrder	getSignalSearchOrder() Gets a signal search order.

Methods inherited from interface org.osid.mapping.path.SignalQuerySession

canSearchSignals, getMap, getMapId, getSignalQuery, getSignalsByQuery, useFederatedMapView, useIsolatedMapView

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

getSignalSearch

SignalSearch getSignalSearch()

Gets a signal search.

Returns:

the signal search

Compliance:

mandatory - This method must be implemented.

getSignalSearchOrder

SignalSearchOrder getSignalSearchOrder()

Gets a signal search order. The SignalSearchOrder is supplied to a SignalSearch to specify the ordering of results.

Returns:

the signal search order

Compliance:

mandatory - This method must be implemented.

getSignalsBySearch

SignalSearchResults getSignalsBySearch(SignalQuery signalQuery,
                                     SignalSearch signalSearch)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

signalQuery - the signal query

signalSearch - the signal search

Returns:

the returned search results

Throws:

NullArgumentException - signalQuery or signalSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - signalQuery or signalSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getSignalQueryFromInspector

SignalQuery getSignalQueryFromInspector(SignalQueryInspector signalQueryInspector)

Gets a signal query from an inspector. The inspector is available from a SignalSearchResults.

Parameters:

signalQueryInspector - a signal query inspector

Returns:

the signal query

Throws:

NullArgumentException - signalQueryInspector is null

UnsupportedException - signalQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.