Interface PaymentSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PaymentQuerySession

public interface PaymentSearchSession
extends PaymentQuerySession

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

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

Payments may have a query record indicated by their respective record types. The queryrecord is accessed via the PaymentQuery .

Method Summary

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

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 PaymentQuerySession

canSearchPayments, getBusiness, getBusinessId, getPaymentQuery, getPaymentsByQuery, useFederatedBusinessView, useIsolatedBusinessView

Modifier and Type	Method	Description
boolean	canSearchPayments()	Tests if this user can perform Payment lookups.
Business	getBusiness()	Gets the Business associated with this session.
Id	getBusinessId()	Gets the Business Id associated with this session.
PaymentQuery	getPaymentQuery()	Gets a payment query.
PaymentList	getPaymentsByQuery(PaymentQuery paymentQuery)	Gets a list of Payments matching the given payment query.
void	useFederatedBusinessView()	Federates the view for methods in this session.
void	useIsolatedBusinessView()	Isolates the view for methods in this session.

Method Details

getPaymentSearch

PaymentSearch getPaymentSearch()

Gets a payment search.

Returns:

the payment search

Compliance:

mandatory - This method must be implemented.

getPaymentSearchOrder

PaymentSearchOrder getPaymentSearchOrder()

Gets a payment search order. The PaymentSearchOrder is supplied to a PaymentSearch to specify the ordering of results.

Returns:

the payment search order

Compliance:

mandatory - This method must be implemented.

getPaymentsBySearch

PaymentSearchResults getPaymentsBySearch(PaymentQuery paymentQuery,
 PaymentSearch paymentSearch)
                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

paymentQuery - the payment query

paymentSearch - the payment search

Returns:

the payment search results

Throws:

NullArgumentException - paymentQuery or paymentSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - paymentQuery or paymentSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPaymentQueryFromInspector

PaymentQuery getPaymentQueryFromInspector(ItemQueryInspector paymentQueryInspector)

Gets a payment query from an inspector. The inspector is available from a PaymentSearchResults .

Parameters:

paymentQueryInspector - a payment query inspector

Returns:

the payment query

Throws:

NullArgumentException - paymentQueryInspector is null

UnsupportedException - paymentQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.