public interface RenovationSearchSession extends RenovationQuerySession
This session provides methods for searching Renovation
objects. The search query is constructed using the RenovationQuery.
The renovation record Type
also specifies the
record for the renovation query.
getRenovationsByQuery()
is the basic search method and
returns a list of Renovation
elements. A more advanced
search may be performed with getRenovationsBySearch().
It
accepts a RenovationSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as ordering. getRenovationeBySearch()
returns a
RenovationSearchResults
that can be used to access the resulting
RenovationList
or be used to perform a search within the
result set through RenovationSearch.
Renovations may have a query record indicated by their respective
record types. The query record is accessed via the RenovationQuery.
The returns in this session may not be cast directly to these
interfaces.
Modifier and Type | Method and Description |
---|---|
RenovationQuery |
getRenovationQueryFromInspector(RenovationQueryInspector renovationQueryInspector)
Gets an entry query from an inspector.
|
RenovationSearchResults |
getRenovationsBySearch(RenovationQuery renovationQuery,
RenovationSearch renovationSearch)
Gets the search results matching the given search.
|
RenovationSearch |
getRenovationSearch()
Gets a renovation search.
|
RenovationSearchOrder |
getRenovationSearchOrder()
Gets a renovation search order.
|
canSearchRenovations, getCampus, getCampusId, getRenovationQuery, getRenovationsByQuery, useFederatedCampusView, useIsolatedCampusView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
RenovationSearch getRenovationSearch()
mandatory
- This method must be implemented. RenovationSearchOrder getRenovationSearchOrder()
RenovationSearchOrder
is supplied to a RenovationSearch
to specify
the ordering of results.mandatory
- This method must be implemented. RenovationSearchResults getRenovationsBySearch(RenovationQuery renovationQuery, RenovationSearch renovationSearch) throws OperationFailedException, PermissionDeniedException
renovationQuery
- the renovation queryrenovationSearch
- the renovation searchNullArgumentException
- renovationQuery
or renovationSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- renovationQuery
or renovationSearch
is not of this servicemandatory
- This method must be implemented. RenovationQuery getRenovationQueryFromInspector(RenovationQueryInspector renovationQueryInspector)
RenovationSearchResults.
renovationQueryInspector
- a query inspectorNullArgumentException
- renovationQueryInspector
is null
UnsupportedException
- renovationQueryInspector
is not of this servicemandatory
- This method must be implemented.