org.osid.mapping.path.rules

Interface SignalEnablerSearchSession

All Superinterfaces:

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

public interface SignalEnablerSearchSession
extends SignalEnablerQuerySession

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

getSignalEnablersByQuery() is the basic search method and returns a list of SignalEnablers. A more advanced search may be performed with getSignalEnablersBySearch(). It accepts a SignalEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as mapping. getSignalEnablersBySearch() returns a SignalEnablerSearchResults that can be used to access the resulting SignalEnablerList or be used to perform a search within the result set through SignalEnablerSearch.

This session defines views that offer differing behaviors for searching.

• federated map view: searches include signal enabler in map of which this map matchmaker is an ancestor in the map hierarchy
• isolated map view: searches are restricted to signal enabler in this office

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

Method Summary

Methods

Modifier and Type	Method and Description
SignalEnablerQuery	getSignalEnablerQueryFromInspector(SignalEnablerQueryInspector signalEnablerQueryInspector) Gets a signal enabler query from an inspector.
SignalEnablerSearchResults	getSignalEnablersBySearch(SignalEnablerQuery signalEnablerQuery, SignalEnablerSearch signalEnablerSearch) Gets the search results matching the given search query using the given search.
SignalEnablerSearch	getSignalEnablerSearch() Gets a signal enabler search.
SignalEnablerSearchOrder	getSignalEnablerSearchOrder() Gets a signal enabler search order.

Methods inherited from interface org.osid.mapping.path.rules.SignalEnablerQuerySession

canSearchSignalEnablers, getMap, getMapId, getSignalEnablerQuery, getSignalEnablersByQuery, 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

getSignalEnablerSearch

SignalEnablerSearch getSignalEnablerSearch()

Gets a signal enabler search.

Returns:

the signal enabler search

Compliance:

mandatory - This method must be implemented.

getSignalEnablerSearchOrder

SignalEnablerSearchOrder getSignalEnablerSearchOrder()

Gets a signal enabler search order. The SignalEnablerSearchOrder is supplied to a SignalEnablerSearch to specify the ordering of results.

Returns:

the signal enabler search order

Compliance:

mandatory - This method must be implemented.

getSignalEnablersBySearch

SignalEnablerSearchResults getSignalEnablersBySearch(SignalEnablerQuery signalEnablerQuery,
                                                   SignalEnablerSearch signalEnablerSearch)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

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

Parameters:

signalEnablerQuery - the signal enabler query

signalEnablerSearch - the signal enabler search

Returns:

the returned search results

Throws:

NullArgumentException - signalEnablerQuery or signalEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - signalEnablerQuery or signalEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getSignalEnablerQueryFromInspector

SignalEnablerQuery getSignalEnablerQueryFromInspector(SignalEnablerQueryInspector signalEnablerQueryInspector)

Gets a signal enabler query from an inspector. The inspector is available from a SignalEnablerSearchResults.

Parameters:

signalEnablerQueryInspector - a signal enabler query inspector

Returns:

the signal enabler query

Throws:

NullArgumentException - signalEnablerQueryInspector is null

UnsupportedException - signalEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.