Interface PayerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PayerQuerySession

public interface PayerSearchSession
extends PayerQuerySession

This session provides methods for searching among Payers . The search query is constructed using the PayerQuery .

getPayersByQuery() is the basic search method and returns a list of Payers . A more advanced search may be performed with getPayersBySearch() . It accepts a PayerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPayersBySearch() returns a PayerSearchResults that can be used to access the resulting PayerList or be used to perform a search within the result set through PayerSearch .

This session defines views that offer differing behaviors for searching.

• federated business view: searches include payers in businesses of which this business is an ancestor in the business hierarchy
• isolated business view: searches are restricted to payers in this business

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

Method Summary

Modifier and Type	Method	Description
PayerQuery	getPayerQueryFromInspector(PayerQueryInspector payerQueryInspector)	Gets a payer query from an inspector.
PayerSearchResults	getPayersBySearch(PayerQuery payerQuery, PayerSearch payerSearch)	Gets the search results matching the given search query using the given search.
PayerSearch	getPayerSearch()	Gets a payer search.
PayerSearchOrder	getPayerSearchOrder()	Gets a payer search order.

Methods inherited from interface Closeable

close

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.

Methods inherited from interface PayerQuerySession

canSearchPayers, getBusiness, getBusinessId, getPayerQuery, getPayersByQuery, useFederatedBusinessView, useIsolatedBusinessView

Modifier and Type	Method	Description
boolean	canSearchPayers()	Tests if this user can perform Payer searches.
Business	getBusiness()	Gets the Business associated with this session.
Id	getBusinessId()	Gets the Business Id associated with this session.
PayerQuery	getPayerQuery()	Gets a payer query.
PayerList	getPayersByQuery(PayerQuery payerQuery)	Gets a list of Payers matching the given payer query.
void	useFederatedBusinessView()	Federates the view for methods in this session.
void	useIsolatedBusinessView()	Isolates the view for methods in this session.

Method Details

getPayerSearch

PayerSearch getPayerSearch()

Gets a payer search.

Returns:

the payer search

Compliance:

mandatory - This method must be implemented.

getPayerSearchOrder

PayerSearchOrder getPayerSearchOrder()

Gets a payer search order. The PayerSearchOrder is supplied to a PayerSearch to specify the ordering of results.

Returns:

the payer search order

Compliance:

mandatory - This method must be implemented.

getPayersBySearch

PayerSearchResults getPayersBySearch(PayerQuery payerQuery,
 PayerSearch payerSearch)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

payerQuery - the payer query

payerSearch - the payer search

Returns:

the payer search results

Throws:

NullArgumentException - payerQuery or payerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - payerQuery or payerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPayerQueryFromInspector

PayerQuery getPayerQueryFromInspector(PayerQueryInspector payerQueryInspector)

Gets a payer query from an inspector. The inspector is available from a PayerSearchResults .

Parameters:

payerQueryInspector - a payer query inspector

Returns:

the payer query

Throws:

NullArgumentException - payerQueryInspector is null

UnsupportedException - payerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.