org.osid.inquiry.rules

Interface InquiryEnablerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, InquiryEnablerQuerySession, 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

Methods

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

canSearchInquiryEnablers, getInquest, getInquestId, getInquiryEnablerQuery, getInquiryEnablersByQuery, 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

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.