public interface UtilitySearchSession extends UtilityQuerySession
This session provides methods for searching Utility
objects. The search query is constructed using the UtilityQuery.
The utility record Type
also specifies the recod
for the utility query.
getUtilitiesByQuery()
is the basic search method and
returns a list of Utility
elements. A more advanced search
may be performed with getUtilitiesBySearch().
It accepts a
UtilitySearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getUtilitiesBySearch()
returns a
UtilitySearchResults
that can be used to access the resulting
UtilityList
or be used to perform a search within the
result set through UtilitySearch.
Utilities may have a query record indicated by their respective record
types. The query record is accessed via the UtilityQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
UtilitySearchResults |
getUtilitiesBySearch(UtilityQuery utilityQuery,
UtilitySearch utilitySearch)
Gets the search results matching the given search.
|
UtilityQuery |
getUtilityQueryFromInspector(UtilityQueryInspector utilityQueryInspector)
Gets a utility query from an inspector.
|
UtilitySearch |
getUtilitySearch()
Gets a utility search.
|
UtilitySearchOrder |
getUtilitySearchOrder()
Gets a utility search order.
|
canSearchUtilities, getUtilitiesByQuery, getUtilityQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
UtilitySearch getUtilitySearch()
mandatory
- This method must be implemented. UtilitySearchOrder getUtilitySearchOrder()
UtilitySearchOrder
is
supplied to a UtilitySearch
to specify the ordering of
results.mandatory
- This method must be implemented. UtilitySearchResults getUtilitiesBySearch(UtilityQuery utilityQuery, UtilitySearch utilitySearch) throws OperationFailedException, PermissionDeniedException
utilityQuery
- the utility queryutilitySearch
- the utility searchNullArgumentException
- utilityQuery
or
utilitySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- utilityQuery
or
utilitySearch
is not of this servicemandatory
- This method must be implemented. UtilityQuery getUtilityQueryFromInspector(UtilityQueryInspector utilityQueryInspector)
UtilitySearchResults.
utilityQueryInspector
- a utility query inspectorNullArgumentException
- utilityQueryInspector
is null
UnsupportedException
- utilityQueryInspector
is not of this servicemandatory
- This method must be implemented.