public interface ConferralSearchSession extends ConferralQuerySession
This session provides methods for searching Conferral
objects. The search query is constructed using the ConferralQuery.
The conferral record Type
also specifies the record
for the conferral query.
getConferralsByQuery()
is the basic search method and
returns a list of Academy
elements. A more advanced search
may be performed with getConferralsBySearch().
It accepts a
ConferralSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getConferralsBySearch()
returns a
ConferralSearchResults
that can be used to access the resulting
ConferralList
or be used to perform a search within the
result set through ConferralSearch.
Conferrals may have a query record indicated by their respective
record types. The query record is accessed via the ConferralQuery.
The returns in this session may not be cast directly to these
interfaces.
Modifier and Type | Method and Description |
---|---|
ConferralQuery |
getConferralQueryFromInspector(ConferralQueryInspector conferralQueryInspector)
Gets a conferral query from an inspector.
|
ConferralSearchResults |
getConferralsBySearch(ConferralQuery conferralQuery,
ConferralSearch conferralSearch)
Gets the search results matching the given search.
|
ConferralSearch |
getConferralSearch()
Gets a conferral search.
|
ConferralSearchOrder |
getConferralSearchOrder()
Gets a conferral search order.
|
canSearchConferrals, getAcademy, getAcademyId, getConferralQuery, getConferralsByQuery, useFederatedAcademyView, useIsolatedAcademyView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ConferralSearch getConferralSearch()
mandatory
- This method must be implemented. ConferralSearchOrder getConferralSearchOrder()
ConferralSearchOrder
is supplied to a ConferralSearch
to specify the
ordering of results.mandatory
- This method must be implemented. ConferralSearchResults getConferralsBySearch(ConferralQuery conferralQuery, ConferralSearch conferralSearch) throws OperationFailedException, PermissionDeniedException
conferralQuery
- the conferral queryconferralSearch
- the conferral searchNullArgumentException
- conferralQuery
or conferralSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- conferralQuery
or
conferralSearch
is not of this servicemandatory
- This method must be implemented. ConferralQuery getConferralQueryFromInspector(ConferralQueryInspector conferralQueryInspector)
ConferralSearchResults.
conferralQueryInspector
- a conferral query inspectorNullArgumentException
- conferralQueryInspector
is null
UnsupportedException
- conferralQueryInspector
is not of this servicemandatory
- This method must be implemented.