public interface PayerSearchSession extends PayerQuerySession
This session provides methods for searching among Payer
objects. 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.
Payers may have a query record indicated by their respective record
types. The query record is accessed via the PayerQuery.
Modifier and Type | Method and 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.
|
canSearchPayers, getBusiness, getBusinessId, getPayerQuery, getPayersByQuery, useFederatedBusinessView, useIsolatedBusinessView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PayerSearch getPayerSearch()
mandatory
- This method must be implemented. PayerSearchOrder getPayerSearchOrder()
PayerSearchOrder
is
supplied to a PayerSearch
to specify the ordering of
results.mandatory
- This method must be implemented. PayerSearchResults getPayersBySearch(PayerQuery payerQuery, PayerSearch payerSearch) throws OperationFailedException, PermissionDeniedException
payerQuery
- the payer querypayerSearch
- the payer searchNullArgumentException
- payerQuery
or
payerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- payerQuery
or
payerSearch
is not of this servicemandatory
- This method must be implemented. PayerQuery getPayerQueryFromInspector(PayerQueryInspector payerQueryInspector)
PayerSearchResults.
payerQueryInspector
- a payer query inspectorNullArgumentException
- payerQueryInspector
is null
UnsupportedException
- payerQueryInspector
is not of this servicemandatory
- This method must be implemented.