public interface DocetSearchSession extends DocetQuerySession
This session provides methods for searching Docet
objects. The search query is constructed using the DocetQuery.
The docet record Type
also specifies the record for
the docet query.
getDocetsByQuery()
is the basic search method and
returns a list of Docet
elements. A more advanced search
may be performed with getDocetsBySearch().
It accepts an
DocetSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getDocetsBySearch()
returns an
DocetSearchResults
that can be used to access the resulting
DocetList
or be used to perform a search within the result set
through DocetSearch.
Docetsmay have a query record indicated by their respective record
types. The query record is accessed via the DocetQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
DocetQuery |
getDocetQueryFromInspector(DocetQueryInspector docetQueryInspector)
Gets a docet query from an inspector.
|
DocetSearchResults |
getDocetsBySearch(DocetQuery docetQuery,
DocetSearch docetSearch)
Gets the search results matching the given search.
|
DocetSearch |
getDocetSearch()
Gets a docet search.
|
DocetSearchOrder |
getDocetSearchOrder()
Gets a docet search order.
|
canSearchDocets, getCourseCatalog, getCourseCatalogId, getDocetQuery, getDocetsByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
DocetSearch getDocetSearch()
mandatory
- This method must be implemented. DocetSearchOrder getDocetSearchOrder()
DocetSearchOrder
is
supplied to an DocetSearch
to specify the ordering of
results.mandatory
- This method must be implemented. DocetSearchResults getDocetsBySearch(DocetQuery docetQuery, DocetSearch docetSearch) throws OperationFailedException, PermissionDeniedException
docetQuery
- the docet querydocetSearch
- the docet searchNullArgumentException
- docetQuery
or
docetSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- docetQuery
or
docetSearch
is not of this servicemandatory
- This method must be implemented. DocetQuery getDocetQueryFromInspector(DocetQueryInspector docetQueryInspector)
DocetSearchResults.
docetQueryInspector
- a docet query inspectorNullArgumentException
- docetQueryInspector
is null
UnsupportedException
- docetQueryInspector
is not of this servicemandatory
- This method must be implemented.