org.osid.ontology

Interface RelevancySearchSession

All Superinterfaces:

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

public interface RelevancySearchSession
extends RelevancyQuerySession

This session provides methods for searching Relevancy objects. The search query is constructed using the RelevancyQuery. The relevancy record Type also specifies the record for the relevancy query.

getRelevanciesByQuery() is the basic search method and returns a list of relevancies. A more advanced search may be performed with getRelevanciesBySearch(). It accepts a RelevancySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRelevanciesBySearch() returns a RelevancySearchResults that can be used to access the resulting RelevancyList or be used to perform a search within the result set through RelevancySearch.

This session defines views that offer differing behaviors for searching.

• federated ontology view: searches include relevancies in ontologies of which this ontology is a ancestor in the ontology hierarchy
• isolated ontology view: searches are restricted

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

Method Summary

Methods

Modifier and Type	Method and Description
RelevancySearchResults	getRelevanciesBySearch(RelevancyQuery relevancyQuery, RelevancySearch relevancySearch) Gets the search results matching the given search query using the given search.
RelevancyQuery	getRelevancyQueryFromInspector(RelevancyQueryInspector relevancyQueryInspector) Gets a relevancy query from an inspector.
RelevancySearch	getRelevancySearch() Gets a relevancy search.
RelevancySearchOrder	getRelevancySearchOrder() Gets a relevancy search order.

Methods inherited from interface org.osid.ontology.RelevancyQuerySession

canSearchRelevancies, getOntology, getOntologyId, getRelevanciesByQuery, getRelevancyQuery, useFederatedOntologyView, useIsolatedOntologyView

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

getRelevancySearch

RelevancySearch getRelevancySearch()

Gets a relevancy search.

Returns:

the relevancy search

Compliance:

mandatory - This method must be implemented.

getRelevancySearchOrder

RelevancySearchOrder getRelevancySearchOrder()

Gets a relevancy search order. The RelevancySearchOrder is supplied to a RelevancySearch to specify the ordering of results.

Returns:

the relevancy search order

Compliance:

mandatory - This method must be implemented.

getRelevanciesBySearch

RelevancySearchResults getRelevanciesBySearch(RelevancyQuery relevancyQuery,
                                            RelevancySearch relevancySearch)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

relevancyQuery - the relevancy query

relevancySearch - the relevancy search

Returns:

the relevancy search results

Throws:

NullArgumentException - relevancyQuery or relevancySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - relevancySearch or relevancyQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getRelevancyQueryFromInspector

RelevancyQuery getRelevancyQueryFromInspector(RelevancyQueryInspector relevancyQueryInspector)

Gets a relevancy query from an inspector. The inspector is available from a RelevancySearchResults.

Parameters:

relevancyQueryInspector - a relevancy query inspector

Returns:

the relevancy query

Throws:

NullArgumentException - relevancyQueryInspector is null

UnsupportedException - relevancyQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.