public interface InstallationSearchSession extends InstallationQuerySession
This session provides methods for searching Installations.
The search query is constructed using the
InstallationQuery.
The installation record Type
also specifies the record for the installation query.
getInstallationsByQuery()
is the basic search method
and returns a list of Installations.
A more advanced search
may be performed with getInstallationsBySearch().
It
accepts an InstallationSearch
in addition to the query for
the purpose of specifying additional options affecting the entire search,
such as ordering. getInstallationsBySearch()
returns an
InstallationSearchResults
that can be used to access the
resulting InstallationList
or be used to perform a search
within the result set through InstallationSearch.
Installations may have a query record indicated by their respective
record types. The query record is accessed via the
InstallationQuery.
Modifier and Type | Method and Description |
---|---|
InstallationSearchResults |
getInstallationsBySearch(InstallationQuery installationQuery,
InstallationSearch installationSearch)
Gets the search results matching the given search query using the
given search.
|
InstallationSearch |
getInstallationSearch()
Gets an installation search.
|
InstallationSearchOrder |
getInstallationSearchOrder()
Gets an installation search order.
|
InstallationQuery |
getInstallationsQueryFromInspector(InstallationQueryInspector installatonQueryInspector)
Gets a installation query from an inspector.
|
canSearchInstallations, getInstallationQuery, getInstallationsByQuery, getSite, getSiteId, useDenormalizedDependencyView, useDenormalizedVersionView, useNormalizedDependencyView, useNormalizedVersionView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
InstallationSearch getInstallationSearch()
mandatory
- This method must be implemented. InstallationSearchOrder getInstallationSearchOrder()
InstallationSearchOrder
is supplied to an InstallationSearch
to specify
the ordering of results.mandatory
- This method must be implemented. InstallationSearchResults getInstallationsBySearch(InstallationQuery installationQuery, InstallationSearch installationSearch) throws OperationFailedException, PermissionDeniedException
installationQuery
- the installation queryinstallationSearch
- the installation searchNullArgumentException
- installationQuery
or installationSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- installationSearch
or installationQuery
is not of this
servicemandatory
- This method must be implemented. InstallationQuery getInstallationsQueryFromInspector(InstallationQueryInspector installatonQueryInspector)
InstallationSearchResults.
installatonQueryInspector
- a installation query inspectorNullArgumentException
-
installationQueryInspector
is null
UnsupportedException
-
installationQueryInspector
is not of this servicemandatory
- This method must be implemented.