public interface SystemSearchSession extends SystemQuerySession
This session provides methods for searching among System
objects. The search query is constructed using the SystemQuery.
getSystemsByQuery()
is the basic search method and
returns a list of Systems.
A more advanced search may be
performed with getSystemsBySearch().
It accepts a
SystemSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getSystemsBySearch()
returns a
SystemSearchResults
that can be used to access the resulting
SystemList
or be used to perform a search within the result
set through SystemSearch.
Systems may have a query record indicated by their respective record
types. The query record is accessed via the SystemQuery.
Modifier and Type | Method and Description |
---|---|
SystemQuery |
getSystemQueryFromInspector(SystemQueryInspector systemQueryInspector)
Gets a system query from an inspector.
|
SystemSearchResults |
getSystemsBySearch(SystemQuery systemQuery,
SystemSearch systemSearch)
Gets the search results matching the given search query using the
given search.
|
SystemSearch |
getSystemSearch()
Gets a system search.
|
SystemSearchOrder |
getSystemSearchOrder()
Gets a system search order.
|
canSearchSystems, getSystemQuery, getSystemsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
SystemSearch getSystemSearch()
mandatory
- This method must be implemented. SystemSearchOrder getSystemSearchOrder()
SystemSearchOrder
is
supplied to a SystemSearch
to specify the ordering of
results.mandatory
- This method must be implemented. SystemSearchResults getSystemsBySearch(SystemQuery systemQuery, SystemSearch systemSearch) throws OperationFailedException, PermissionDeniedException
systemQuery
- the system querysystemSearch
- the system searchNullArgumentException
- systemQuery
or
systemSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- systemQuery
or
systemSearch
is not of this servicemandatory
- This method must be implemented. SystemQuery getSystemQueryFromInspector(SystemQueryInspector systemQueryInspector)
SystemSearchResults.
systemQueryInspector
- a system query inspectorNullArgumentException
- systemQueryInspector
is null
UnsupportedException
- systemQueryInspector
is not of this servicemandatory
- This method must be implemented.