org.osid.inquiry

Interface InquestSearchSession

All Superinterfaces:

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

public interface InquestSearchSession
extends InquestQuerySession

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

Methods

Modifier and Type	Method and 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 org.osid.inquiry.InquestQuerySession

canSearchInquests, getInquestQuery, getInquestsByQuery

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

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.