public interface ConvocationSearchSession extends ConvocationQuerySession
This session provides methods for searching Convocation
objects. The search query is constructed using the
ConvocationQuery.
The convocation record Type
also
specifies the record for the convocation query.
getConvocationsByQuery()
is the basic search method and
returns a list of Academy
elements. A more advanced search
may be performed with getConvocationsBySearch().
It accepts
a ConvocationSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as ordering. getConvocationsBySearch()
returns a
ConvocationSearchResults
that can be used to access the resulting
ConvocationList
or be used to perform a search within the
result set through ConvocationSearch.
Convocations may have a query record indicated by their respective
record types. The query record is accessed via the
ConvocationQuery.
The returns in this session may not be cast
directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
ConvocationQuery |
getConvocationQueryFromInspector(ConvocationQueryInspector convocationQueryInspector)
Gets a convocation query from an inspector.
|
ConvocationSearchResults |
getConvocationsBySearch(ConvocationQuery convocationQuery,
ConvocationSearch convocationSearch)
Gets the search results matching the given search.
|
ConvocationSearch |
getConvocationSearch()
Gets a convocation search.
|
ConvocationSearchOrder |
getConvocationSearchOrder()
Gets a convocation search order.
|
canSearchConvocations, getAcademy, getAcademyId, getConvocationQuery, getConvocationsByQuery, useFederatedAcademyView, useIsolatedAcademyView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ConvocationSearch getConvocationSearch()
mandatory
- This method must be implemented. ConvocationSearchOrder getConvocationSearchOrder()
ConvocationSearchOrder
is supplied to a ConvocationSearch
to specify
the ordering of results.mandatory
- This method must be implemented. ConvocationSearchResults getConvocationsBySearch(ConvocationQuery convocationQuery, ConvocationSearch convocationSearch) throws OperationFailedException, PermissionDeniedException
convocationQuery
- the convocation queryconvocationSearch
- the convocation searchNullArgumentException
- convocationQuery
or convocationSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- convocationQuery
or convocationSearch
is not of this servicemandatory
- This method must be implemented. ConvocationQuery getConvocationQueryFromInspector(ConvocationQueryInspector convocationQueryInspector)
ConvocationSearchResults.
convocationQueryInspector
- a convocation query inspectorNullArgumentException
-
convocationQueryInspector
is null
UnsupportedException
- convocationQueryInspector
is not of this servicemandatory
- This method must be implemented.