org.cyclos.services.banking

Interface TransactionService

All Superinterfaces:

Service

All Known Subinterfaces:

TransactionServiceLocal

All Known Implementing Classes:

TransactionServiceSecurity

public interface TransactionService
extends Service

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

Author:

luis

Method Summary

Modifier and Type	Method and Description
TransactionData	getData(TransactionVO vo) Returns data for a transaction
Page<MaturityTableItemData>	getMaturityTable(MaturityTableQuery query) returns the maturity table which the user can view in case of paying with a zero d-rate of an earlier account state, when MaturityPolicy.HISTORY is valid.
PerformPaymentData	getPaymentData(InternalAccountOwner from, InternalAccountOwner to, TransferTypeVO transferType) Returns data used to prepare a payment matching the given from / to account owners.
PerformPaymentToOwnerData	getPaymentToOwnerData(InternalAccountOwner from, InternalAccountOwner to, TransferTypeVO transferType) Returns simplified data used to prepare a payment matching the given arguments
PerformPaymentTypeData	getPaymentTypeData(InternalAccountOwner from, InternalAccountOwner to, TransferTypeVO transferType) Returns the data related to a payment type for a payment
ReceivePaymentData	getReceivePaymentData() Returns data used to receive a payment
ReceivePaymentFromUserData	getReceivePaymentFromUserData(UserLocatorVO locator, TransferTypeVO transferType) Returns data used to receive a payment from a specific user.
PerformPaymentTypeData	getReceivePaymentTypeData(UserLocatorVO locator, TransferTypeVO transferType) Returns the data related to a payment type for receiving a payment from a specific user and payment type
TransactionSearchData	getSearchData(InternalAccountOwner 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
void	requestNewOTPForReceive(PerformInternalTransactionDTO parameters, SendMedium medium) Generates a new OTP (removing any previous password, if any) and sends it to the payer by the specified medium using the confirmation password type for the BuiltInChannel.POS channel for the specified payer. It has the same security controls as for PaymentService.receive(PerformPaymentDTO), that is the logged user must be allowed to receive payments from the specified payer.
Page<TransactionEntryVO>	search(TransactionQuery query) Searches for transactions, according to the given query

Method Detail

getData

TransactionData getData(@NotNull
                        TransactionVO vo)
                 throws FrameworkException

Returns data for a transaction

Throws:

FrameworkException

getMaturityTable

Page<MaturityTableItemData> getMaturityTable(@NotNull
                                             MaturityTableQuery query)
                                      throws FrameworkException

returns the maturity table which the user can view in case of paying with a zero d-rate of an earlier account state, when MaturityPolicy.HISTORY is valid.

Throws:

FrameworkException

getPaymentData

PerformPaymentData getPaymentData(InternalAccountOwner from,
                                  InternalAccountOwner to,
                                  TransferTypeVO transferType)
                           throws FrameworkException

Returns data used to prepare a payment matching the given from / to account owners. The given payment type is optional. If not passed in, will return detailed data for the first available payment type. If passed in, will return detailed data for that payment type, and must be valid.

Throws:

FrameworkException

getPaymentToOwnerData

PerformPaymentToOwnerData getPaymentToOwnerData(InternalAccountOwner from,
                                                InternalAccountOwner to,
                                                TransferTypeVO transferType)
                                         throws FrameworkException

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

Throws:

FrameworkException

getPaymentTypeData

PerformPaymentTypeData getPaymentTypeData(InternalAccountOwner from,
                                          InternalAccountOwner to,
                                          TransferTypeVO transferType)
                                   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,
                                                         TransferTypeVO transferType)
                                                  throws FrameworkException,
                                                         PosPayerException

Returns data used to receive a payment from a specific user. The given payment type is optional. If not passed in, will return detailed data for the first available payment type. If passed in, will return detailed data for that payment type, and must be valid.

Throws:

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

FrameworkException

PosPayerException

getReceivePaymentTypeData

PerformPaymentTypeData getReceivePaymentTypeData(UserLocatorVO locator,
                                                 TransferTypeVO transferType)
                                          throws FrameworkException,
                                                 PosPayerException

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

Throws:

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

FrameworkException

PosPayerException

getSearchData

TransactionSearchData getSearchData(InternalAccountOwner owner)
                             throws FrameworkException

Returns data used to search for transactions for the given owner

Throws:

FrameworkException

load

TransactionVO load(@NotNull
                   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(@NotNull
                                      java.lang.String transactionNumber)
                               throws FrameworkException

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

Throws:

FrameworkException

print

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

Generates a PDF file for a transaction details

Throws:

FrameworkException

requestNewOTPForReceive

void requestNewOTPForReceive(@NotNull
                             PerformInternalTransactionDTO parameters,
                             @NotNull
                             SendMedium medium)
                      throws FrameworkException,
                             SmsSendingException

Generates a new OTP (removing any previous password, if any) and sends it to the payer by the specified medium using the confirmation password type for the BuiltInChannel.POS channel for the specified payer.
It has the same security controls as for PaymentService.receive(PerformPaymentDTO), that is the logged user must be allowed to receive payments from the specified payer.

Parameters:

parameters - the payment to be received.

medium - the medium used to send the OTP.

Throws:

SmsSendingException - only if medium is SendMedium.SMS and the OTP could not be sent to any enabled for sms phone.

FrameworkException

search

Page<TransactionEntryVO> search(@NotNull
                                TransactionQuery query)
                         throws FrameworkException

Searches for transactions, according to the given query

Throws:

FrameworkException