public interface ProgramEntrySearchSession extends ProgramEntryQuerySession
This session provides methods for searching among
ProgramEntries.
The search query is constructed using the
ProgramEntryQuery.
getProgramEntriesByQuery()
is the basic search method
and returns a list of ProgramEntries.
A more advanced
search may be performed with getProgramEntriesBySearch().
It accepts a ProgramEntrySearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as ordering. getProgramEntriesBySearch()
returns a ProgramEntrySearchResults
that can be used to
access the resulting ProgramEntryList
or be used to perform
a search within the result set through ProgramEntrySearch.
This session defines views that offer differing behaviors for searching.
ProgramEntries may have a query record indicated by their respective
record types. The query record is accessed via the
ProgramEntryQuery.
Modifier and Type | Method and Description |
---|---|
ProgramEntrySearchResults |
getProgramEntriesBySearch(ProgramEntryQuery programEntryQuery,
ProgramEntrySearch programEntrySearch)
Gets the search results matching the given search query using the
given search.
|
ProgramEntryQuery |
getProgramEntryQueryFromInspector(ProgramEntryQueryInspector programEntryQueryInspector)
Gets a program entry query from an inspector.
|
ProgramEntrySearch |
getProgramEntrySearch()
Gets a program entry search.
|
ProgramEntrySearchOrder |
getProgramEntrySearchOrder()
Gets a program entry search order.
|
canSearchProgramEntries, getCourseCatalog, getCourseCatalogId, getProgramEntriesByQuery, getProgramEntryQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProgramEntrySearch getProgramEntrySearch()
mandatory
- This method must be implemented. ProgramEntrySearchOrder getProgramEntrySearchOrder()
ProgramEntrySearchOrder
is supplied to a ProgramEntrySearch
to specify
the ordering of results.mandatory
- This method must be implemented. ProgramEntrySearchResults getProgramEntriesBySearch(ProgramEntryQuery programEntryQuery, ProgramEntrySearch programEntrySearch) throws OperationFailedException, PermissionDeniedException
programEntryQuery
- the program entry queryprogramEntrySearch
- the program entry searchNullArgumentException
- programEntryQuery
or programEntrySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- programEntryQuery
or ProgramEntrySearch
is not of this servicemandatory
- This method must be implemented. ProgramEntryQuery getProgramEntryQueryFromInspector(ProgramEntryQueryInspector programEntryQueryInspector)
ProgramEntrySearchResults.
programEntryQueryInspector
- a program entry query inspectorNullArgumentException
-
programEntryQueryInspector
is null
UnsupportedException
-
programEntryQueryInspector
is not of this servicemandatory
- This method must be implemented.