Interface TermSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, TermQuerySession

public interface TermSearchSession
extends TermQuerySession

This session provides methods for searching among Terms . The search query is constructed using the TermQuery .

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

This session defines views that offer differing behaviors for searching.

• federated course catalog view: searches include terms in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
• isolated course catalog view: searches are restricted to terms in this course catalog

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

Method Summary

Modifier and Type	Method	Description
TermQuery	getTermQueryFromInspector(TermQueryInspector termQueryInspector)	Gets a term query from an inspector.
TermSearchResults	getTermsBySearch(TermQuery termQuery, TermSearch termSearch)	Gets the search results matching the given search query using the given search.
TermSearch	getTermSearch()	Gets a term search.
TermSearchOrder	getTermSearchOrder()	Gets a term search order.

Methods inherited from interface Closeable

close

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.

Methods inherited from interface TermQuerySession

canSearchTerms, getCourseCatalog, getCourseCatalogId, getTermQuery, getTermsByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchTerms()	Tests if this user can perform Term lookups.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
TermQuery	getTermQuery()	Gets a term query.
TermList	getTermsByQuery(TermQuery termQuery)	Gets a list of Terms matching the given term query.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	Isolates the view for methods in this session.

Method Details

getTermSearch

TermSearch getTermSearch()

Gets a term search.

Returns:

the term search

Compliance:

mandatory - This method must be implemented.

getTermSearchOrder

TermSearchOrder getTermSearchOrder()

Gets a term search order. The TermSearchOrder is supplied to a TermSearch to specify the ordering of results.

Returns:

the term search order

Compliance:

mandatory - This method must be implemented.

getTermsBySearch

TermSearchResults getTermsBySearch(TermQuery termQuery,
 TermSearch termSearch)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

termQuery - the term query

termSearch - the term search

Returns:

the term search results

Throws:

NullArgumentException - termQuery or termSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - termQuery or termSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getTermQueryFromInspector

TermQuery getTermQueryFromInspector(TermQueryInspector termQueryInspector)

Gets a term query from an inspector. The inspector is available from a TermSearchResults .

Parameters:

termQueryInspector - a term query inspector

Returns:

the term query

Throws:

NullArgumentException - termQueryInspector is null

UnsupportedException - termQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.