Interface InquiryEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, InquiryEnablerQuerySession, OsidSession, OsidSession

public interface InquiryEnablerSearchSession
extends InquiryEnablerQuerySession

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

getInquiryEnablersByQuery() is the basic search method and returns a list of InquiryEnablers . A more advanced search may be performed with getInquiryEnablersBySearch() . It accepts an InquiryEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as inquiry. getInquiryEnablersBySearch() returns an InquiryEnablerSearchResults that can be used to access the resulting InquiryEnablerList or be used to perform a search within the result set through InquiryEnablerSearch .

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
InquiryEnablerQuery	getInquiryEnablerQueryFromInspector(InquiryEnablerQueryInspector inquiryEnablerQueryInspector)	Gets an inquiry enabler query from an inspector.
InquiryEnablerSearchResults	getInquiryEnablersBySearch(InquiryEnablerQuery inquiryEnablerQuery, InquiryEnablerSearch inquiryEnablerSearch)	Gets the search results matching the given search query using the given search.
InquiryEnablerSearch	getInquiryEnablerSearch()	Gets an inquiry enabler search.
InquiryEnablerSearchOrder	getInquiryEnablerSearchOrder()	Gets an inquiry enabler search order.

Methods inherited from interface Closeable

close

Methods inherited from interface InquiryEnablerQuerySession

canSearchInquiryEnablers, getInquest, getInquestId, getInquiryEnablerQuery, getInquiryEnablersByQuery, useFederatedInquestView, useIsolatedInquestView

Modifier and Type	Method	Description
boolean	canSearchInquiryEnablers()	Tests if this user can perform InquiryEnabler lookups.
Inquest	getInquest()	Gets the Inquest associated with this session.
Id	getInquestId()	Gets the Inquest Id associated with this session.
InquiryEnablerQuery	getInquiryEnablerQuery()	Gets an inquiry enabler query.
InquiryEnablerList	getInquiryEnablersByQuery(InquiryEnablerQuery inquiryEnablerQuery)	Gets a list of InquiryEnablers matching the given search.
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

getInquiryEnablerSearch

InquiryEnablerSearch getInquiryEnablerSearch()

Gets an inquiry enabler search.

Returns:

the inquiry enabler search

Compliance:

mandatory - This method must be implemented.

getInquiryEnablerSearchOrder

InquiryEnablerSearchOrder getInquiryEnablerSearchOrder()

Gets an inquiry enabler search order. The InquiryEnablerSearchOrder is supplied to an InquiryEnablerSearch to specify the ordering of results.

Returns:

the inquiry enabler search order

Compliance:

mandatory - This method must be implemented.

getInquiryEnablersBySearch

InquiryEnablerSearchResults getInquiryEnablersBySearch(InquiryEnablerQuery inquiryEnablerQuery,
 InquiryEnablerSearch inquiryEnablerSearch)
                                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

inquiryEnablerQuery - the inquiry enabler query

inquiryEnablerSearch - the inquiry enabler search

Returns:

the returned search results

Throws:

NullArgumentException - inquiryEnablerQuery or inquiryEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - inquiryEnablerQuery or inquiryEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getInquiryEnablerQueryFromInspector

InquiryEnablerQuery getInquiryEnablerQueryFromInspector(InquiryEnablerQueryInspector inquiryEnablerQueryInspector)

Gets an inquiry enabler query from an inspector. The inspector is available from an InquiryEnablerSearchResults .

Parameters:

inquiryEnablerQueryInspector - an inquiry enabler query inspector

Returns:

the inquiry enabler query

Throws:

NullArgumentException - inquiryEnablerQueryInspector is null

UnsupportedException - inquiryEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.