public interface MeterSearchSession extends MeterQuerySession
This session provides methods for searching among meters. The search
query is constructed using the MeterQuery.
getMetersByQuery()
is the basic search method and
returns a list of meters. A more advanced search may be performed with
getMetersBySearch().
It accepts a MeterSearch
in addition to the query for the purpose of specifying additional
options affecting the entire search, such as ordering.
getMetersBySearch()
returns a MeterSearchResults
that can be used to access the resulting MeterList
or be
used to perform a search within the result set through MeterSearch.
This session defines views that offer differing behaviors for searching.
Modifier and Type | Method and Description |
---|---|
MeterQuery |
getMeterQueryFromInspector(MeterQueryInspector meterQueryInspector)
Gets a meter query from an inspector.
|
MeterSearchResults |
getMetersBySearch(MeterQuery meterQuery,
MeterSearch meterSearch)
Gets the search results matching the given search query using the
given search.
|
MeterSearch |
getMeterSearch()
Gets a meter search.
|
MeterSearchOrder |
getMeterSearchOrder()
Gets a meter search order.
|
canSearchMeters, getMeterQuery, getMetersByQuery, getUtility, getUtilityId, useFederatedUtilityView, useIsolatedUtilityView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
MeterSearch getMeterSearch()
mandatory
- This method must be implemented. MeterSearchOrder getMeterSearchOrder()
MeterSearchOrder
is
supplied to a MeterSearch
to specify the ordering of
results.mandatory
- This method must be implemented. MeterSearchResults getMetersBySearch(MeterQuery meterQuery, MeterSearch meterSearch) throws OperationFailedException, PermissionDeniedException
meterQuery
- the meter querymeterSearch
- the meter searchNullArgumentException
- meterQuery
or
meterSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- meterQuery
or
meterSearch
is not of this servicemandatory
- This method must be implemented. MeterQuery getMeterQueryFromInspector(MeterQueryInspector meterQueryInspector)
MeterSearchResults.
meterQueryInspector
- a meter query inspectorNullArgumentException
- meterQueryInspector
is null
UnsupportedException
- meterQueryInspector
is not of this servicemandatory
- This method must be implemented.