Interface LessonSearchSession

All Superinterfaces:

AutoCloseable, Closeable, LessonQuerySession, OsidSession, OsidSession

public interface LessonSearchSession
extends LessonQuerySession

This session provides methods for searching Lessons. The search query is constructed using the LessonQuery. The lesson record Type also specifies the record for the lesson query.

getLessonsByQuery() is the basic search method and returns a list of Lesson elements. A more advanced search may be performed with getLessonsBySearch(). It accepts a LessonSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getLessonsBySearch() returns a LessonSearchResults that can be used to access the resulting LessonList or be used to perform a search within the result set through LessonSearch.

Lessons may have a query record indicated by their respective record types. The query record is accessed via the LessonQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
LessonQuery	getLessonQueryFromInspector(LessonQueryInspector lessonQueryInspector)	Gets a lesson query from an inspector.
LessonSearchResults	getLessonsBySearch(LessonQuery lessonQuery, LessonSearch lessonSearch)	Gets the search results matching the given search.
LessonSearch	getLessonSearch()	Gets a lesson search.
LessonSearchOrder	getLessonSearchOrder()	Gets a lesson search order.

Methods inherited from interface Closeable

close

Methods inherited from interface LessonQuerySession

canSearchLessons, getCourseCatalog, getCourseCatalogId, getLessonQuery, getLessonsByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchLessons()	Tests if this user can perform Lesson searches.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
LessonQuery	getLessonQuery()	Gets a lesson query.
LessonList	getLessonsByQuery(LessonQuery lessonQuery)	Gets a list of Lessons matching the given search.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	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

getLessonSearch

LessonSearch getLessonSearch()

Gets a lesson search.

Returns:

the lesson search

Compliance:

mandatory - This method must be implemented.

getLessonSearchOrder

LessonSearchOrder getLessonSearchOrder()

Gets a lesson search order. The LessonSearchOrder is supplied to a LessonSearch to specify the ordering of results.

Returns:

the lesson search order

Compliance:

mandatory - This method must be implemented.

getLessonsBySearch

LessonSearchResults getLessonsBySearch(LessonQuery lessonQuery,
 LessonSearch lessonSearch)
                                throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

lessonQuery - the lesson query

lessonSearch - the lesson search

Returns:

the lesson search results

Throws:

NullArgumentException - lessonQuery or lessonSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - lessonQuery or lessonSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getLessonQueryFromInspector

LessonQuery getLessonQueryFromInspector(LessonQueryInspector lessonQueryInspector)

Gets a lesson query from an inspector. The inspector is available from a LessonSearchResults.

Parameters:

lessonQueryInspector - a lesson query inspector

Returns:

the course catalog query

Throws:

NullArgumentException - lessonQueryInspector is null

UnsupportedException - lessonQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.