Interface ResponseSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ResponseQuerySession

public interface ResponseSearchSession
extends ResponseQuerySession

This session provides methods for searching among Responses . The search query is constructed using the ResponseQuery .

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

This session defines views that offer differing behaviors for searching.

• federated inquest view: searches include responses in inquests of which this inquest is an ancestor in the inquest hierarchy
• isolated inquest view: searches are restricted to responses in this inquest

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

Method Summary

Modifier and Type	Method	Description
ResponseQuery	getResponseQueryFromInspector(ResponseQueryInspector responseQueryInspector)	Gets a response query from an inspector.
ResponseSearchResults	getResponsesBySearch(ResponseQuery responseQuery, ResponseSearch responseSearch)	Gets the search results matching the given search query using the given search.
ResponseSearch	getResponseSearch()	Gets a response search.
ResponseSearchOrder	getResponseSearchOrder()	Gets a response 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 ResponseQuerySession

canSearchResponses, getInquest, getInquestId, getResponseQuery, getResponsesByQuery, useFederatedInquestView, useIsolatedInquestView

Modifier and Type	Method	Description
boolean	canSearchResponses()	Tests if this user can perform Response lookups.
Inquest	getInquest()	Gets the Inquest associated with this session.
Id	getInquestId()	Gets the Inquest Id associated with this session.
ResponseQuery	getResponseQuery()	Gets a response query.
ResponseList	getResponsesByQuery(ResponseQuery responseQuery)	Gets a list of Responses matching the given response query.
void	useFederatedInquestView()	Federates the view for methods in this session.
void	useIsolatedInquestView()	Isolates the view for methods in this session.

Method Details

getResponseSearch

ResponseSearch getResponseSearch()

Gets a response search.

Returns:

the response search

Compliance:

mandatory - This method must be implemented.

getResponseSearchOrder

ResponseSearchOrder getResponseSearchOrder()

Gets a response search order. The ResponseSearchOrder is supplied to a ResponseSearch to specify the ordering of results.

Returns:

the response search order

Compliance:

mandatory - This method must be implemented.

getResponsesBySearch

ResponseSearchResults getResponsesBySearch(ResponseQuery responseQuery,
 ResponseSearch responseSearch)
                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

responseQuery - the response query

responseSearch - the response search

Returns:

the returned search results

Throws:

NullArgumentException - responseQuery or responseSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - responseQuery or responseSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getResponseQueryFromInspector

ResponseQuery getResponseQueryFromInspector(ResponseQueryInspector responseQueryInspector)

Gets a response query from an inspector. The inspector is available from a ResponseSearchResults .

Parameters:

responseQueryInspector - a response query inspector

Returns:

the response query

Throws:

NullArgumentException - responseQueryInspector is null

UnsupportedException - responseQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.