Interface InquestSearchSession

All Superinterfaces:

AutoCloseable, Closeable, InquestQuerySession, OsidSession, OsidSession

public interface InquestSearchSession
extends InquestQuerySession

This session provides methods for searching among Inquests . The search query is constructed using the InquestQuery .

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

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

Method Summary

Modifier and Type	Method	Description
InquestQuery	getInquestQueryFromInspector(InquestQueryInspector inquestQueryInspector)	Gets an inquest query from an inspector.
InquestSearchResults	getInquestsBySearch(InquestQuery inquestQuery, InquestSearch inquestSearch)	Gets the search results matching the given search query using the given search.
InquestSearch	getInquestSearch()	Gets an inquest search.
InquestSearchOrder	getInquestSearchOrder()	Gets an inquest search order.

Methods inherited from interface Closeable

close

Methods inherited from interface InquestQuerySession

canSearchInquests, getInquestQuery, getInquestsByQuery

Modifier and Type	Method	Description
boolean	canSearchInquests()	Tests if this user can perform Inquest searches.
InquestQuery	getInquestQuery()	Gets an inquest query.
InquestList	getInquestsByQuery(InquestQuery inquestQuery)	Gets a list of Inquests matching the given inquest query.

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.

Method Details

getInquestSearch

InquestSearch getInquestSearch()

Gets an inquest search.

Returns:

the inquest search

Compliance:

mandatory - This method must be implemented.

getInquestSearchOrder

InquestSearchOrder getInquestSearchOrder()

Gets an inquest search order. The InquestSearchOrder is supplied to an InquestSearch to specify the ordering of results.

Returns:

the inquest search order

Compliance:

mandatory - This method must be implemented.

getInquestsBySearch

InquestSearchResults getInquestsBySearch(InquestQuery inquestQuery,
 InquestSearch inquestSearch)
                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

inquestQuery - the inquest query

inquestSearch - the inquest search

Returns:

the inquest search results

Throws:

NullArgumentException - inquestQuery or inquestSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - inquestQuery or inquestSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getInquestQueryFromInspector

InquestQuery getInquestQueryFromInspector(InquestQueryInspector inquestQueryInspector)

Gets an inquest query from an inspector. The inspector is available from an InquestSearchResults .

Parameters:

inquestQueryInspector - an inquest query inspector

Returns:

the inquest query

Throws:

NullArgumentException - inquestQueryInspector is null

UnsupportedException - inquestQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.