public interface RequisiteSearchSession extends RequisiteQuerySession
This session provides methods for searching among Requisites.
The search query is constructed using the RequisiteQuery.
getRequisitesByQuery()
is the basic search method and
returns a list of Requisites.
A more advanced search may be
performed with getRequisitesBySearch().
It accepts a
RequisiteSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getRequisitesBySearch()
returns a
RequisiteSearchResults
that can be used to access the resulting
RequisiteList
or be used to perform a search within the
result set through RequisiteSearch.
This session defines views that offer differing behaviors for searching.
Requisites may have a query record indicated by their respective
record types. The query record is accessed via the RequisiteQuery.
Modifier and Type | Method and Description |
---|---|
RequisiteQuery |
getRequisiteQueryFromInspector(RequisiteQueryInspector requisiteQueryInspector)
Gets a requisite query from an inspector.
|
RequisiteSearchResults |
getRequisitesBySearch(RequisiteQuery requisiteQuery,
RequisiteSearch requisiteSearch)
Gets the search results matching the given search query using the
given search.
|
RequisiteSearch |
getRequisiteSearch()
Gets a requisite search.
|
RequisiteSearchOrder |
getRequisiteSearchOrder()
Gets a requisite search order.
|
canSearchRequisites, getCourseCatalog, getCourseCatalogId, getRequisiteQuery, getRequisitesByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView, useSequesteredRequisiteView, useUnsequesteredRequisiteView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
RequisiteSearch getRequisiteSearch()
mandatory
- This method must be implemented. RequisiteSearchOrder getRequisiteSearchOrder()
RequisiteSearchOrder
is supplied to a RequisiteSearch
to specify the
ordering of results.mandatory
- This method must be implemented. RequisiteSearchResults getRequisitesBySearch(RequisiteQuery requisiteQuery, RequisiteSearch requisiteSearch) throws OperationFailedException, PermissionDeniedException
requisiteQuery
- the requisite queryrequisiteSearch
- the requisite searchNullArgumentException
- requisiteQuery
or requisiteSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- requisiteQuery
or
requisiteSearch
is not of this servicemandatory
- This method must be implemented. RequisiteQuery getRequisiteQueryFromInspector(RequisiteQueryInspector requisiteQueryInspector)
RequisiteSearchResults.
requisiteQueryInspector
- a requisite query inspectorNullArgumentException
- requisiteQueryInspector
is null
UnsupportedException
- requisiteQueryInspector
is not of this servicemandatory
- This method must be implemented.