org.cyclos.services.banking

Interface TransactionService

All Superinterfaces:

Service

All Known Subinterfaces:

TransactionServiceLocal

public interface TransactionService
extends Service

Service interface to access generic transactions, be them payments or scheduled payments

Author:

luis

Method Summary

Methods

Modifier and Type	Method and Description
PerformPaymentData	getPaymentData(AccountOwner from, AccountOwner to) Returns data used to prepare a payment matching the given arguments
PerformPaymentToOwnerData	getPaymentToOwnerData(AccountOwner from, AccountOwner to) Returns simplified data used to prepare a payment matching the given arguments
PerformPaymentTypeData	getPaymentTypeData(AccountOwner from, AccountOwner to, java.lang.Long paymentTypeId) Returns the data related to a payment type for a payment
ReceivePaymentData	getReceivePaymentData() Returns data used to receive a payment
ReceivePaymentFromUserData	getReceivePaymentFromUserData(UserLocatorVO locator) Returns data used to receive a payment from a specific user
PerformPaymentTypeData	getReceivePaymentTypeData(UserLocatorVO locator, java.lang.Long paymentTypeId) Returns the data related to a payment type for receiving a payment from a specific user and payment type
TransactionSearchData	getSearchData(AccountOwner owner) Returns data used to search for transactions for the given owner
TransactionVO	load(java.lang.Long id) Loads a transaction details by id, returning a proper detailed implementation (for example, PaymentVO or ScheduledPaymentVO).
TransactionVO	loadByTransactionNumber(java.lang.String transactionNumber) Returns a transfer by transaction number, or throws EntityNotFoundException if not found
SerializableInputStream	print(java.lang.Long id) Generates a PDF file for a transaction details
Page<TransactionEntryVO>	search(BaseTransactionQuery query) Searches for transactions, according to the given query

Method Detail

getPaymentData

PerformPaymentData getPaymentData(AccountOwner from,
                                AccountOwner to)
                                  throws FrameworkException

Returns data used to prepare a payment matching the given arguments

Throws:

FrameworkException

getPaymentToOwnerData

PerformPaymentToOwnerData getPaymentToOwnerData(AccountOwner from,
                                              AccountOwner to)
                                                throws FrameworkException

Returns simplified data used to prepare a payment matching the given arguments

Throws:

FrameworkException

getPaymentTypeData

PerformPaymentTypeData getPaymentTypeData(AccountOwner from,
                                        AccountOwner to,
                                        java.lang.Long paymentTypeId)
                                          throws FrameworkException

Returns the data related to a payment type for a payment

Throws:

FrameworkException

getReceivePaymentData

ReceivePaymentData getReceivePaymentData()
                                         throws FrameworkException

Returns data used to receive a payment

Throws:

FrameworkException

getReceivePaymentFromUserData

ReceivePaymentFromUserData getReceivePaymentFromUserData(UserLocatorVO locator)
                                                         throws FrameworkException,
                                                                UserNotInPosChannelException

Returns data used to receive a payment from a specific user

Throws:

UserNotInPosChannelException - When the chosen user doesn't have the POS channel enabled (either by preference or permission)

FrameworkException

getReceivePaymentTypeData

PerformPaymentTypeData getReceivePaymentTypeData(UserLocatorVO locator,
                                               java.lang.Long paymentTypeId)
                                                 throws FrameworkException,
                                                        UserNotInPosChannelException

Returns the data related to a payment type for receiving a payment from a specific user and payment type

Throws:

UserNotInPosChannelException - When the chosen user doesn't have the POS channel enabled (either by preference or permission)

FrameworkException

getSearchData

TransactionSearchData getSearchData(AccountOwner owner)
                                    throws FrameworkException

Returns data used to search for transactions for the given owner

Throws:

FrameworkException

load

TransactionVO load(java.lang.Long id)
                   throws FrameworkException

Loads a transaction details by id, returning a proper detailed implementation (for example, PaymentVO or ScheduledPaymentVO).

Throws:

FrameworkException

loadByTransactionNumber

TransactionVO loadByTransactionNumber(java.lang.String transactionNumber)
                                      throws FrameworkException

Returns a transfer by transaction number, or throws EntityNotFoundException if not found

Throws:

FrameworkException

print

SerializableInputStream print(java.lang.Long id)
                              throws FrameworkException

Generates a PDF file for a transaction details

Throws:

FrameworkException

search

Page<TransactionEntryVO> search(BaseTransactionQuery query)
                                throws FrameworkException

Searches for transactions, according to the given query

Throws:

FrameworkException