Interface DemographicSearchSession

All Superinterfaces:

AutoCloseable, Closeable, DemographicQuerySession, OsidSession, OsidSession

public interface DemographicSearchSession
extends DemographicQuerySession

This session provides methods for searching among Demographics . 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.

• federated bin view: searches include demographic in bins of which this bin is an ancestor in the bin hierarchy
• isolated bin view: searches are restricted to demographic in this bin

Demographics may have a query record indicated by their respective record types. The query record is accessed via the DemographicQuery .

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface DemographicQuerySession

canSearchDemographics, getBin, getBinId, getDemographicQuery, getDemographicsByQuery, useFederatedBinView, useIsolatedBinView

Modifier and Type	Method	Description
boolean	canSearchDemographics()	Tests if this user can perform Demographic lookups.
Bin	getBin()	Gets the Bin associated with this session.
Id	getBinId()	Gets the Bin Id associated with this session.
DemographicQuery	getDemographicQuery()	Gets a demographic query.
DemographicList	getDemographicsByQuery(DemographicQuery demographicQuery)	Gets a list of Demographics matching the given demographic query.
void	useFederatedBinView()	Federates the view for methods in this session.
void	useIsolatedBinView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getDemographicSearch

DemographicSearch getDemographicSearch()

Gets a demographic search.

Returns:

the demographic search

Compliance:

mandatory - This method must be implemented.

getDemographicSearchOrder

DemographicSearchOrder getDemographicSearchOrder()

Gets a demographic search order. The DemographicSearchOrder is supplied to a DemographicSearch to specify the ordering of results.

Returns:

the demographic search order

Compliance:

mandatory - This method must be implemented.

getDemographicsBySearch

DemographicSearchResults getDemographicsBySearch(DemographicQuery demographicQuery,
 DemographicSearch demographicSearch)
                                          throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

demographicQuery - the demographic query

demographicSearch - the demographic search

Returns:

the returned search results

Throws:

NullArgumentException - demographicQuery or demographicSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - demographicQuery or demographicSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getDemographicQueryFromInspector

DemographicQuery getDemographicQueryFromInspector(DemographicQueryInspector demographicQueryInspector)

Gets a demographic query from an inspector. The inspector is available from a DemographicSearchResults .

Parameters:

demographicQueryInspector - a demographic query inspector

Returns:

the demographic query

Throws:

NullArgumentException - demographicQueryInspector is null

UnsupportedException - demographicQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.