public interface LessonSearchSession extends LessonQuerySession
This session provides methods for searching Lesson
objects. 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.
Modifier and Type | Method and 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.
|
canSearchLessons, getCourseCatalog, getCourseCatalogId, getLessonQuery, getLessonsByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
LessonSearch getLessonSearch()
mandatory
- This method must be implemented. LessonSearchOrder getLessonSearchOrder()
LessonSearchOrder
is
supplied to a LessonSearch
to specify the ordering of
results.mandatory
- This method must be implemented. LessonSearchResults getLessonsBySearch(LessonQuery lessonQuery, LessonSearch lessonSearch) throws OperationFailedException, PermissionDeniedException
lessonQuery
- the lesson querylessonSearch
- the lesson searchNullArgumentException
- lessonQuery
or
lessonSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- lessonQuery
or
lessonSearch
is not of this servicemandatory
- This method must be implemented. LessonQuery getLessonQueryFromInspector(LessonQueryInspector lessonQueryInspector)
LessonSearchResults.
lessonQueryInspector
- a lesson query inspectorNullArgumentException
- lessonQueryInspector
is null
UnsupportedException
- lessonQueryInspector
is not of this servicemandatory
- This method must be implemented.