public interface DemographicEnablerSearchSession extends DemographicEnablerQuerySession
This session provides methods for searching among
DemographicEnabler
objects. The search query is constructed using
the DemographicEnableryQuery.
getDemographicEnablersByQuery()
is the basic search
method and returns a list of DemographicEnablers.
A more
advanced search may be performed with
getDemographicEnablersBySearch().
It accepts a
DemographicEnablerSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as bin.
getDemographicEnablersBySearch()
returns a
DemographicEnablerSearchResults
that can be used to access the
resulting DemographicEnablerList
or be used to perform a
search within the result set through DemographicEnablerSearch.
This session defines views that offer differing behaviors for searching.
DemographicEnablers
may have a query record indicated
by their respective record types. The query record is accessed via the
DemographicEnablerQuery.
Modifier and Type | Method and Description |
---|---|
DemographicEnablerQuery |
getDemographicEnablerQueryFromInspector(DemographicEnablerQueryInspector demographicEnablerQueryInspector)
Gets a demographic enabler query from an inspector.
|
DemographicEnablerSearchResults |
getDemographicEnablersBySearch(DemographicEnablerQuery demographicEnablerQuery,
DemographicEnablerSearch demographicEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
DemographicEnablerSearch |
getDemographicEnablerSearch()
Gets a demographic enabler search.
|
DemographicEnablerSearchOrder |
getDemographicEnablerSearchOrder()
Gets a demographic enabler search order.
|
canSearchDemographicEnablers, getBin, getBinId, getDemographicEnablerQuery, getDemographicEnablersByQuery, useFederatedBinView, useIsolatedBinView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
DemographicEnablerSearch getDemographicEnablerSearch()
mandatory
- This method must be implemented. DemographicEnablerSearchOrder getDemographicEnablerSearchOrder()
DemographicEnablerSearchOrder
is supplied to a
DemographicEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. DemographicEnablerSearchResults getDemographicEnablersBySearch(DemographicEnablerQuery demographicEnablerQuery, DemographicEnablerSearch demographicEnablerSearch) throws OperationFailedException, PermissionDeniedException
demographicEnablerQuery
- the demographic enabler querydemographicEnablerSearch
- the demographic enabler searchNullArgumentException
- demographicEnablerQuery
or demographicEnablerSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- demographicEnablerQuery
or demographicEnablerSearch
is not of
this servicemandatory
- This method must be implemented. DemographicEnablerQuery getDemographicEnablerQueryFromInspector(DemographicEnablerQueryInspector demographicEnablerQueryInspector)
DemographicEnablerSearchResults.
demographicEnablerQueryInspector
- a demographic enabler query
inspectorNullArgumentException
-
demographicEnablerQueryInspector
is null
UnsupportedException
-
demographicEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.