Interface SettingSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, SettingQuerySession

public interface SettingSearchSession
extends SettingQuerySession

This session provides methods for searching among Settings . The search query is constructed using the SettingQuery .

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

This session defines views that offer differing behaviors for searching.

• federated system view: searches include settings in systems of which this system is an ancestor in the system hierarchy
• isolated system view: searches are restricted to settings in this system

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

Method Summary

Modifier and Type	Method	Description
SettingQuery	getSettingQueryFromInspector(SettingQueryInspector settingQueryInspector)	Gets a setting query from an inspector.
SettingSearchResults	getSettingsBySearch(SettingQuery settingQuery, SettingSearch settingSearch)	Gets the search results matching the given search query using the given search.
SettingSearch	getSettingSearch()	Gets a setting search.
SettingSearchOrder	getSettingSearchOrder()	Gets a setting 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 SettingQuerySession

canSearchSettings, getSettingQuery, getSettingsByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView

Modifier and Type	Method	Description
boolean	canSearchSettings()	Tests if this user can perform Setting lookups.
SettingQuery	getSettingQuery()	Gets a setting query.
SettingList	getSettingsByQuery(SettingQuery settingQuery)	Gets a list of Settings matching the given setting query.
System	getSystem()	Gets the System associated with this session.
Id	getSystemId()	Gets the System Id associated with this session.
void	useFederatedSystemView()	Federates the view for methods in this session.
void	useIsolatedSystemView()	Isolates the view for methods in this session.

Method Details

getSettingSearch

SettingSearch getSettingSearch()

Gets a setting search.

Returns:

the setting search

Compliance:

mandatory - This method must be implemented.

getSettingSearchOrder

SettingSearchOrder getSettingSearchOrder()

Gets a setting search order. The SettingSearchOrder is supplied to a SettingSearch to specify the ordering of results.

Returns:

the setting search order

Compliance:

mandatory - This method must be implemented.

getSettingsBySearch

SettingSearchResults getSettingsBySearch(SettingQuery settingQuery,
 SettingSearch settingSearch)
                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

settingQuery - the setting query

settingSearch - the setting search

Returns:

the returned search results

Throws:

NullArgumentException - settingQuery or settingSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - settingQuery or settingSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getSettingQueryFromInspector

SettingQuery getSettingQueryFromInspector(SettingQueryInspector settingQueryInspector)

Gets a setting query from an inspector. The inspector is available from a SettingSearchResults .

Parameters:

settingQueryInspector - a setting query inspector

Returns:

the setting query

Throws:

NullArgumentException - settingQueryInspector is null

UnsupportedException - settingQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.