Interface InquirySearchSession

All Superinterfaces:

AutoCloseable, Closeable, InquiryQuerySession, OsidSession, OsidSession

public interface InquirySearchSession
extends InquiryQuerySession

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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface InquiryQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchInquiries()	Tests if this user can perform Inquiry lookups.
Inquest	getInquest()	Gets the Inquest associated with this session.
Id	getInquestId()	Gets the Inquest Id associated with this session.
InquiryList	getInquiriesByQuery(InquiryQuery inquiryQuery)	Gets a list of Inquiries matching the given inquiry query,
InquiryQuery	getInquiryQuery()	Gets an inquiry query.
void	useFederatedInquestView()	Federates the view for methods in this session.
void	useIsolatedInquestView()	Isolates the view for methods in this session.

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

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.