public interface CourseEntrySearchSession extends CourseEntryQuerySession
This session provides methods for searching among CourseEntries.
The search query is constructed using the CourseEntryQuery.
getCourseEntriesByQuery()
is the basic search method
and returns a list of CourseEntries.
A more advanced search
may be performed with getCourseEntriesBySearch().
It
accepts a CourseEntrySearch
in addition to the query for
the purpose of specifying additional options affecting the entire search,
such as ordering. getCourseEntriesBySearch()
returns a
CourseEntrySearchResults
that can be used to access the
resulting CourseEntryList
or be used to perform a search
within the result set through CourseEntrySearch.
This session defines views that offer differing behaviors for searching.
CourseEntries may have a query record indicated by their respective
record types. The query record is accessed via the
CourseEntryQuery.
Modifier and Type | Method and Description |
---|---|
CourseEntrySearchResults |
getCourseEntriesBySearch(CourseEntryQuery courseEntryQuery,
CourseEntrySearch courseEntrySearch)
Gets the search results matching the given search query using the
given search.
|
CourseEntryQuery |
getCourseEntryQueryFromInspector(CourseEntryQueryInspector courseEntryQueryInspector)
Gets a course entry query from an inspector.
|
CourseEntrySearch |
getCourseEntrySearch()
Gets a course entry search.
|
CourseEntrySearchOrder |
getCourseEntrySearchOrder()
Gets a course entry search order.
|
canSearchCourseEntries, getCourseCatalog, getCourseCatalogId, getCourseEntriesByQuery, getCourseEntryQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
CourseEntrySearch getCourseEntrySearch()
mandatory
- This method must be implemented. CourseEntrySearchOrder getCourseEntrySearchOrder()
CourseEntrySearchOrder
is supplied to a CourseEntrySearch
to specify
the ordering of results.mandatory
- This method must be implemented. CourseEntrySearchResults getCourseEntriesBySearch(CourseEntryQuery courseEntryQuery, CourseEntrySearch courseEntrySearch) throws OperationFailedException, PermissionDeniedException
courseEntryQuery
- the course entry querycourseEntrySearch
- the course entry searchNullArgumentException
- courseEntryQuery
or courseEntrySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- courseEntryQuery
or CourseEntrySearch
is not of this servicemandatory
- This method must be implemented. CourseEntryQuery getCourseEntryQueryFromInspector(CourseEntryQueryInspector courseEntryQueryInspector)
CourseEntrySearchResults.
courseEntryQueryInspector
- a course entry query inspectorNullArgumentException
-
courseEntryQueryInspector
is null
UnsupportedException
- courseEntryQueryInspector
is not of this servicemandatory
- This method must be implemented.