public interface SyllabusSearchSession extends SyllabusQuerySession
This session provides methods for searching Syllabus
objects. The search query is constructed using the SyllabusQuery.
The syllabus record Type
also specifies the record
for the syllabus query.
getSyllabiByQuery()
is the basic search method and
returns a list of CourseCatalog
elements. A more advanced
search may be performed with getSyllabiBySearch().
It
accepts a SyllabusSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as ordering. getSyllabiBySearch()
returns a
SyllabusSearchResults
that can be used to access the resulting
SyllabusList
or be used to perform a search within the
result set through SyllabusSearch.
Syllabi may have a query record indicated by their respective record
types. The query record is accessed via the SyllabusQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
SyllabusSearchResults |
getSyllabiBySearch(SyllabusQuery syllabusQuery,
SyllabusSearch syllabusSearch)
Gets the search results matching the given search.
|
SyllabusQuery |
getSyllabusQueryFromInspector(SyllabusQueryInspector syllabusQueryInspector)
Gets a syllabus query from an inspector.
|
SyllabusSearch |
getSyllabusSearch()
Gets a syllabus search.
|
SyllabusSearchOrder |
getSyllabusSearchOrder()
Gets a syllabus search order.
|
canSearchSyllabi, getCourseCatalog, getCourseCatalogId, getSyllabiByQuery, getSyllabusQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
SyllabusSearch getSyllabusSearch()
mandatory
- This method must be implemented. SyllabusSearchOrder getSyllabusSearchOrder()
SyllabusSearchOrder
is supplied to a SyllabusSearch
to specify the ordering
of results.mandatory
- This method must be implemented. SyllabusSearchResults getSyllabiBySearch(SyllabusQuery syllabusQuery, SyllabusSearch syllabusSearch) throws OperationFailedException, PermissionDeniedException
syllabusQuery
- the syllabus querysyllabusSearch
- the syllabus searchNullArgumentException
- syllabusQuery
or
syllabusSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- syllabusQuery
or
syllabusSearch
is not of this servicemandatory
- This method must be implemented. SyllabusQuery getSyllabusQueryFromInspector(SyllabusQueryInspector syllabusQueryInspector)
SyllabusSearchResults.
syllabusQueryInspector
- a syllabus query inspectorNullArgumentException
- syllabusQueryInspector
is null
UnsupportedException
- syllabusQueryInspector
is not of this servicemandatory
- This method must be implemented.