Interface SignalEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, 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

Modifier and Type	Method	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 Closeable

close

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.

Methods inherited from interface SignalEnablerQuerySession

canSearchSignalEnablers, getMap, getMapId, getSignalEnablerQuery, getSignalEnablersByQuery, useFederatedMapView, useIsolatedMapView

Modifier and Type	Method	Description
boolean	canSearchSignalEnablers()	Tests if this user can perform SignalEnabler lookups.
Map	getMap()	Gets the Map associated with this session.
Id	getMapId()	Gets the Map Id associated with this session.
SignalEnablerQuery	getSignalEnablerQuery()	Gets a signal enabler query.
SignalEnablerList	getSignalEnablersByQuery(SignalEnablerQuery signalEnablerQuery)	Gets a list of SignalEnablers matching the given signal enabler query.
void	useFederatedMapView()	Federates the view for methods in this session.
void	useIsolatedMapView()	Isolates the view for methods in this session.

Method Details

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.