org.osid.billing.payment

Interface PaymentSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, PaymentQuerySession

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.

• 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

Methods

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.

Methods inherited from interface org.osid.billing.payment.PaymentQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.