org.osid.inquiry

Interface InquirySearchSession

All Superinterfaces:

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

public interface InquirySearchSession
extends InquiryQuerySession

This session provides methods for searching among Inquiry objects. The search query is constructed using the InquiryQuery.

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
InquirySearchResults	getInquiriesBySearch(InquiryQuery inquiryQuery, InquirySearch inquirySearch) Gets the search results matching the given search query using the given search.
InquiryQuery	getInquiryQueryFromInspector(InquiryQueryInspector inquiryQueryInspector) Gets an inquiry query from an inspector.
InquirySearch	getInquirySearch() Gets an inquiry search.
InquirySearchOrder	getInquirySearchOrder() Gets an inquiry search order.

Methods inherited from interface org.osid.inquiry.InquiryQuerySession

canSearchInquiries, getInquest, getInquestId, getInquiriesByQuery, getInquiryQuery, useFederatedInquestView, useIsolatedInquestView

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

getInquirySearch

InquirySearch getInquirySearch()

Gets an inquiry search.

Returns:

the inquiry search

Compliance:

mandatory - This method must be implemented.

getInquirySearchOrder

InquirySearchOrder getInquirySearchOrder()

Gets an inquiry search order. The InquirySearchOrder is supplied to an InquirySearch to specify the ordering of results.

Returns:

the inquiry search order

Compliance:

mandatory - This method must be implemented.

getInquiriesBySearch

InquirySearchResults getInquiriesBySearch(InquiryQuery inquiryQuery,
                                        InquirySearch inquirySearch)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

inquiryQuery - the inquiry query

inquirySearch - the inquiry search

Returns:

the inquiry search results

Throws:

NullArgumentException - inquiryQuery or inquirySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - inquiryQuery or inquirySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getInquiryQueryFromInspector

InquiryQuery getInquiryQueryFromInspector(InquiryQueryInspector inquiryQueryInspector)

Gets an inquiry query from an inspector. The inspector is available from an InquirySearchResults.

Parameters:

inquiryQueryInspector - an inquiry query inspector

Returns:

the inquiry query

Throws:

NullArgumentException - inquiryQueryInspector is null

UnsupportedException - inquiryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.