public interface DemographicSearchSession extends DemographicQuerySession
This session provides methods for searching among Demographic
objects. The search query is constructed using the
DemographicyQuery.
getDemographicsByQuery()
is the basic search method and
returns a list of Demographics.
A more advanced search may
be performed with getDemographicsBySearch().
It accepts a
DemographicSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as bin.
getDemographicsBySearch()
returns a
DemographicSearchResults
that can be used to access the resulting
DemographicList
or be used to perform a search within the
result set through DemographicSearch.
This session defines views that offer differing behaviors for searching.
Demographics
may have a query record indicated by their
respective record types. The query record is accessed via the
DemographicQuery.
Modifier and Type | Method and Description |
---|---|
DemographicQuery |
getDemographicQueryFromInspector(DemographicQueryInspector demographicQueryInspector)
Gets a demographic query from an inspector.
|
DemographicSearchResults |
getDemographicsBySearch(DemographicQuery demographicQuery,
DemographicSearch demographicSearch)
Gets the search results matching the given search query using the
given search.
|
DemographicSearch |
getDemographicSearch()
Gets a demographic search.
|
DemographicSearchOrder |
getDemographicSearchOrder()
Gets a demographic search order.
|
canSearchDemographics, getBin, getBinId, getDemographicQuery, getDemographicsByQuery, useFederatedBinView, useIsolatedBinView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
DemographicSearch getDemographicSearch()
mandatory
- This method must be implemented. DemographicSearchOrder getDemographicSearchOrder()
DemographicSearchOrder
is supplied to a DemographicSearch
to specify
the ordering of results.mandatory
- This method must be implemented. DemographicSearchResults getDemographicsBySearch(DemographicQuery demographicQuery, DemographicSearch demographicSearch) throws OperationFailedException, PermissionDeniedException
demographicQuery
- the demographic querydemographicSearch
- the demographic searchNullArgumentException
- demographicQuery
or demographicSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- demographicQuery
or demographicSearch
is not of this servicemandatory
- This method must be implemented. DemographicQuery getDemographicQueryFromInspector(DemographicQueryInspector demographicQueryInspector)
DemographicSearchResults.
demographicQueryInspector
- a demographic query inspectorNullArgumentException
-
demographicQueryInspector
is null
UnsupportedException
- demographicQueryInspector
is not of this servicemandatory
- This method must be implemented.