public interface PaymentSearchSession extends PaymentQuerySession
This session provides methods for searching among Payment
objects. The search query is constructed using the
PaymentQuery.
getPaymentsByQuery()
is the basic search method and
returns a list of Payments.
A more advanced search may be
performed with getPaymentsBySearch().
It accepts a
PaymentSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getPaymentsBySearch()
returns a
PaymentSearchResults
that can be used to access the resulting
PaymentList
or be used to perform a search within the
result set through PaymentSearch.
This session defines views that offer differing behaviors for searching.
Payments may have a query record indicated by their respective record
types. The queryrecord is accessed via the PaymentQuery.
Modifier and Type | Method and Description |
---|---|
PaymentQuery |
getPaymentQueryFromInspector(ItemQueryInspector paymentQueryInspector)
Gets a payment query from an inspector.
|
PaymentSearchResults |
getPaymentsBySearch(PaymentQuery paymentQuery,
PaymentSearch paymentSearch)
Gets the search results matching the given search query using the
given search.
|
PaymentSearch |
getPaymentSearch()
Gets a payment search.
|
PaymentSearchOrder |
getPaymentSearchOrder()
Gets a payment search order.
|
canSearchPayments, getBusiness, getBusinessId, getPaymentQuery, getPaymentsByQuery, useFederatedBusinessView, useIsolatedBusinessView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PaymentSearch getPaymentSearch()
mandatory
- This method must be implemented. PaymentSearchOrder getPaymentSearchOrder()
PaymentSearchOrder
is
supplied to a PaymentSearch
to specify the ordering of
results.mandatory
- This method must be implemented. PaymentSearchResults getPaymentsBySearch(PaymentQuery paymentQuery, PaymentSearch paymentSearch) throws OperationFailedException, PermissionDeniedException
paymentQuery
- the payment querypaymentSearch
- the payment searchNullArgumentException
- paymentQuery
or
paymentSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- paymentQuery
or
paymentSearch
is not of this servicemandatory
- This method must be implemented. PaymentQuery getPaymentQueryFromInspector(ItemQueryInspector paymentQueryInspector)
PaymentSearchResults.
paymentQueryInspector
- a payment query inspectorNullArgumentException
- paymentQueryInspector
is null
UnsupportedException
- paymentQueryInspector
is not of this servicemandatory
- This method must be implemented.