org.osid.control

Interface SettingSearchSession

All Superinterfaces:

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

public interface SettingSearchSession
extends SettingQuerySession

This session provides methods for searching among Setting objects. 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

Methods

Modifier and Type	Method and 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 org.osid.control.SettingQuerySession

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

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

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.