public interface AcademySearchSession extends AcademyQuerySession
This session provides methods for searching Academy
objects. The search query is constructed using the AcademyQuery.
The academy record Type
also specifies the record
for the academy query.
getAcademiesByQuery()
is the basic search method and
returns a list of Academy
elements. A more advanced search
may be performed with getAcademiesBySearch().
It accepts an
AcademySearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getAcademiesBySearch()
returns an
AcademySearchResults
that can be used to access the resulting
AcademyList
or be used to perform a search within the
result set through AcademySearch.
Academies may have a query record indicated by their respective record
types. The query record is accessed via the AcademyQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
AcademySearchResults |
getAcademiesBySearch(AcademyQuery academyQuery,
AcademySearch academySearch)
Gets the search results matching the given search.
|
AcademyQuery |
getAcademyQueryFromInspector(AcademyQueryInspector academyQueryInspector)
Gets an academy query from an inspector.
|
AcademySearch |
getAcademySearch()
Gets an academy search.
|
AcademySearchOrder |
getAcademySearchOrder()
Gets an academy search order.
|
canSearchAcademies, getAcademiesByQuery, getAcademyQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AcademySearch getAcademySearch()
mandatory
- This method must be implemented. AcademySearchOrder getAcademySearchOrder()
AcademySearchOrder
is
supplied to an AcademySearch
to specify the ordering of
results.mandatory
- This method must be implemented. AcademySearchResults getAcademiesBySearch(AcademyQuery academyQuery, AcademySearch academySearch) throws OperationFailedException, PermissionDeniedException
academyQuery
- the academy queryacademySearch
- the academy searchNullArgumentException
- academyQuery
or
academies earch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- academyQuery
or
academies earch
is not of this servicemandatory
- This method must be implemented. AcademyQuery getAcademyQueryFromInspector(AcademyQueryInspector academyQueryInspector)
AcademySearchResults.
academyQueryInspector
- an academy query inspectorNullArgumentException
- academyQueryInspector
is null
UnsupportedException
- academyQueryInspector
is not of this servicemandatory
- This method must be implemented.