public interface RegistrationSearchSession extends RegistrationQuerySession
This session provides methods for searching among Registration
objects. The search query is constructed using the
RegistrationQuery.
getRegistrationsByQuery()
is the basic search method
and returns a list of Registrations.
A more advanced search
may be performed with getRegistrationsBySearch().
It
accepts a RegistrationSearch
in addition to the query for
the purpose of specifying additional options affecting the entire search,
such as ordering. getRegistrationsBySearch()
returns a
RegistrationSearchResults
that can be used to access the
resulting RegistrationList
or be used to perform a search
within the result set through RegistrationSearch.
This session defines views that offer differing behaviors for searching.
Registrations may have a query record indicated by their respective
record types. The query record is accessed via the
RegistrationQuery.
Modifier and Type | Method and Description |
---|---|
RegistrationQuery |
getRegistrationQueryFromInspector(ItemQueryInspector registrationQueryInspector)
Gets a registration query from an inspector.
|
RegistrationSearchResults |
getRegistrationsBySearch(RegistrationQuery registrationQuery,
RegistrationSearch registrationSearch)
Gets the search results matching the given search query using the
given search.
|
RegistrationSearch |
getRegistrationSearch()
Gets a registration search.
|
RegistrationSearchOrder |
getRegistrationSearchOrder()
Gets a registration search order.
|
canSearchRegistrations, getCourseCatalog, getCourseCatalogId, getRegistrationQuery, getRegistrationsByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
RegistrationSearch getRegistrationSearch()
mandatory
- This method must be implemented. RegistrationSearchOrder getRegistrationSearchOrder()
RegistrationSearchOrder
is supplied to a RegistrationSearch
to specify
the ordering of results.mandatory
- This method must be implemented. RegistrationSearchResults getRegistrationsBySearch(RegistrationQuery registrationQuery, RegistrationSearch registrationSearch) throws OperationFailedException, PermissionDeniedException
registrationQuery
- the registration queryregistrationSearch
- the registration searchNullArgumentException
- registrationQuery
or registrationSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- registrationQuery
or registrationSearch
is not of this servicemandatory
- This method must be implemented. RegistrationQuery getRegistrationQueryFromInspector(ItemQueryInspector registrationQueryInspector)
RegistrationSearchResults.
registrationQueryInspector
- a registration query inspectorNullArgumentException
-
registrationQueryInspector
is null
UnsupportedException
-
registrationQueryInspector
is not of this servicemandatory
- This method must be implemented.