public interface PlanSearchSession extends PlanQuerySession
This session provides methods for searching Plan
objects. The search query is constructed using the PlanQuery.
The plan record Type
also specifies the record for
the plan query.
getPlansByQuery()
is the basic search method and
returns a list of CourseCatalog
elements. A more advanced
search may be performed with getPlansBySearch().
It accepts
a PlanSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getPlansBySearch()
returns a
PlanSearchResults
that can be used to access the resulting
PlanList
or be used to perform a search within the result set
through PlanSearch.
Plans may have a query record indicated by their respective record
types. The query record is accessed via the PlanQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
PlanQuery |
getPlanQueryFromInspector(PlanQueryInspector planQueryInspector)
Gets a plan query from an inspector.
|
PlanSearchResults |
getPlansBySearch(PlanQuery planQuery,
PlanSearch planSearch)
Gets the search results matching the given search.
|
PlanSearch |
getPlanSearch()
Gets a plan search.
|
PlanSearchOrder |
getPlanSearchOrder()
Gets a plan search order.
|
canSearchPlans, getCourseCatalog, getCourseCatalogId, getPlanQuery, getPlansByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PlanSearch getPlanSearch()
mandatory
- This method must be implemented. PlanSearchOrder getPlanSearchOrder()
PlanSearchOrder
is
supplied to a PlanSearch
to specify the ordering of
results.mandatory
- This method must be implemented. PlanSearchResults getPlansBySearch(PlanQuery planQuery, PlanSearch planSearch) throws OperationFailedException, PermissionDeniedException
planQuery
- the plan queryplanSearch
- the plan searchNullArgumentException
- planQuery
or
planSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- planQuery
or
planSearch
is not of this servicemandatory
- This method must be implemented. PlanQuery getPlanQueryFromInspector(PlanQueryInspector planQueryInspector)
PlanSearchResults.
planQueryInspector
- a plan query inspectorNullArgumentException
- planQueryInspector
is null
UnsupportedException
- planQueryInspector
is not of this servicemandatory
- This method must be implemented.