org.cyclos.impl.banking

Interface TransactionServiceLocal

All Superinterfaces:

Service, TransactionService

public interface TransactionServiceLocal
extends TransactionService

Local interface for TransactionService

Author:

luis

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_AUTHORIZATION_LEVEL Script bind variable: the AuthorizationLevel (if the payment would be authorized)
static java.lang.String	ATTR_FROM_OWNER Script bind variable: the InternalAccountOwner from
static java.lang.String	ATTR_FROM_OWNER_RESULT Script bind variable: the LocateAccountOwnerResult of the from
static java.lang.String	ATTR_NEW_STATUS Script bind variable: the new status
static java.lang.String	ATTR_OLD_STATUS Script bind variable: the old status
static java.lang.String	ATTR_PAYMENT_TYPE Script bind variable: the PaymentTransferType
static java.lang.String	ATTR_PERFORM_TRANSACTION Script bind variable: the PerformTransactionDTO
static java.lang.String	ATTR_PREVIEW Script bind variable: the PaymentPreviewVO
static java.lang.String	ATTR_TO_OWNER Script bind variable: the AccountOwner to
static java.lang.String	ATTR_TO_OWNER_RESULT Script bind variable: the LocateAccountOwnerResult of the to
static java.lang.String	ATTR_TRANSACTION Script bind variable: the Transaction (only available in the TransactionExtensionPointEvent.CONFIRM event, on the validated phase)

Method Summary

Modifier and Type	Method and Description
<Q extends org.cyclos.impl.utils.persistence.DBQuery<?>> Q	applyStatusesFilter(TransactionNature nature, org.cyclos.entities.banking.QTransaction t, java.util.Set<? extends java.lang.Enum<?>> statuses, Q query) Adds a filter by statuses to the given query according to the nature.
void	check(LocateAccountOwnerResult from, LocateAccountOwnerResult to) Performs security checks for the given transaction parameters
void	check(LocateAccountOwnerResult from, LocateAccountOwnerResult to, TransferType transferType) Performs security checks for the given transaction parameters, taking into account the current session data channel and principal type
void	check(PerformInternalTransactionDTO parameters) Performs security checks for the given transaction parameters
void	checkIgnoringSessionData(LocateAccountOwnerResult from, LocateAccountOwnerResult to, TransferType transferType) Performs security checks for the given transaction parameters, ignoring the current session data channel and principal type
void	checkPaymentParameters(LocateAccountOwnerResult from, LocateAccountOwnerResult to, org.cyclos.impl.banking.PaymentServiceImpl.PaymentOperation paymentOperation, PaymentTransferType paymentType) Checks that a payment can be performed from / to the given owners, with the given payment type
org.cyclos.impl.utils.persistence.DBQuery<?>	createQuery(TransactionNature nature, org.cyclos.entities.banking.QTransaction t, BaseTransactionQuery params) Creates a basic query to search transactions.
PaymentTransferType	fill(BasePaymentTypeData data, LocateAccountOwnerResult from, LocateAccountOwnerResult to, PaymentTransferType paymentType) Fills in the given payment type data from / to the given owners, using the given payment type
void	fill(Transaction transaction, TransactionData data) Fills a transaction data
void	fill(Transaction transaction, TransferType type, org.cyclos.impl.banking.PaymentServiceImpl.PaymentOperation operation, LocateAccountOwnerResult from, LocateAccountOwnerResult to, java.lang.String fromName, java.lang.String toName, java.math.BigDecimal amount, java.lang.String description, java.util.Collection<CustomFieldValueDTO> customValues) Fills data in a transaction
Transaction	findByTransactionNumber(java.lang.String transactionNumber) Returns a transaction by transaction number, or throws EntityNotFoundException if not found
boolean	isCheckConfirmationPassword(PaymentTransferType paymentType, InternalAccountOwner owner, java.math.BigDecimal amount, java.util.Date date) It returns true if the confirmation password must be required according to the channel configuration or if it must not be required (independently of the channel's configuration) because the payment's amount is less than or equal the maximum for a pin-less payment.
java.util.List<PaymentTransferType>	listPaymentTypes(LocateAccountOwnerResult from, LocateAccountOwnerResult to, boolean receive) Returns the possible payment types between the given owners
LocateAccountOwnerResult	locateForPayment(InternalAccountOwner owner) Locate the receiver when performing a payment using the principal types allowed to perform a payment.
LocateAccountOwnerResult	locateForReceiving(InternalAccountOwner owner) Locate the payer when receiving a payment using the principal types allowed to receive a payment. Additionally, it checks if the BuiltInChannel.POS channel is accessible for the located payer.
void	persist(Transaction transaction) Persists the given transaction and immediately performs additional actions, such as calling the CustomFieldValueHandler.processAfterSave(org.cyclos.entities.system.EntityWithCustomValues) method.
org.cyclos.impl.banking.TransactionValidationData	prepareValidation(org.cyclos.impl.banking.PrepareValidationParameter parameter) Returns a validator filled with all common validations, plus some other data which was already loaded.
<T> T	receive(InternalAccountOwner from, java.util.concurrent.Callable<T> action) Sets up the session data for receiving a transaction from the given user, invoking the given Callable in it.
PaymentTransferType	resolvePaymentType(InternalAccountOwner from, AccountOwner to, CurrencyVO currency, Channel channel, PrincipalType principalType, org.cyclos.impl.banking.PaymentServiceImpl.PaymentOperation paymentOperation) Returns the payment type matching the from, to, and optionally, currency according to the given payment operation.
<T extends Transaction & HasTransactionStatus<S>,S extends TransactionStatus> org.cyclos.impl.system.ExtensionPointAccessor	setStatusAndGetExtensionPoint(T transaction, S newStatus) Creates a ExtensionPointAccessor for a status change, fires the validated event and sets new status
TransactionEntryVO	toEntry(InternalAccountOwner owner, Transaction transaction) Converts a transaction to the corresponding entry type
void	updatePerformAfterPreview(PerformTransactionDTO dto, LocateAccountOwnerResult from, LocateAccountOwnerResult to, TransferType paymentType) Updates the given PerformTransactionDTO to make it suitable to be returned again after a preview
void	validateMinTimeBetweenPayments(LocateAccountOwnerResult owner, PaymentTransferType paymentType) Validates the minimum time between payments
void	validatePaymentAmount(LocateAccountOwnerResult from, LocateAccountOwnerResult to, PaymentTransferType paymentType, java.math.BigDecimal amount, java.util.Date date) Validates an amount to be paid from the given account

Methods inherited from interface org.cyclos.services.banking.TransactionService

getData, getMaturityTable, getPaymentData, getPaymentToOwnerData, getPaymentTypeData, getReceivePaymentData, getReceivePaymentFromUserData, getReceivePaymentTypeData, getSearchData, load, loadByTransactionNumber, print, requestNewOTPForReceive, search

Field Detail

ATTR_PERFORM_TRANSACTION

static final java.lang.String ATTR_PERFORM_TRANSACTION

Script bind variable: the PerformTransactionDTO

See Also:

Constant Field Values

ATTR_TRANSACTION

static final java.lang.String ATTR_TRANSACTION

Script bind variable: the Transaction (only available in the TransactionExtensionPointEvent.CONFIRM event, on the validated phase)

See Also:

Constant Field Values

ATTR_PREVIEW

static final java.lang.String ATTR_PREVIEW

Script bind variable: the PaymentPreviewVO

See Also:

Constant Field Values

ATTR_PAYMENT_TYPE

static final java.lang.String ATTR_PAYMENT_TYPE

Script bind variable: the PaymentTransferType

See Also:

Constant Field Values

ATTR_FROM_OWNER

static final java.lang.String ATTR_FROM_OWNER

Script bind variable: the InternalAccountOwner from

See Also:

Constant Field Values

ATTR_TO_OWNER

static final java.lang.String ATTR_TO_OWNER

Script bind variable: the AccountOwner to

See Also:

Constant Field Values

ATTR_FROM_OWNER_RESULT

static final java.lang.String ATTR_FROM_OWNER_RESULT

Script bind variable: the LocateAccountOwnerResult of the from

See Also:

Constant Field Values

ATTR_TO_OWNER_RESULT

static final java.lang.String ATTR_TO_OWNER_RESULT

Script bind variable: the LocateAccountOwnerResult of the to

See Also:

Constant Field Values

ATTR_AUTHORIZATION_LEVEL

static final java.lang.String ATTR_AUTHORIZATION_LEVEL

Script bind variable: the AuthorizationLevel (if the payment would be authorized)

See Also:

Constant Field Values

ATTR_OLD_STATUS

static final java.lang.String ATTR_OLD_STATUS

Script bind variable: the old status

See Also:

Constant Field Values

ATTR_NEW_STATUS

static final java.lang.String ATTR_NEW_STATUS

Script bind variable: the new status

See Also:

Constant Field Values

Method Detail

applyStatusesFilter

<Q extends org.cyclos.impl.utils.persistence.DBQuery<?>> Q applyStatusesFilter(@NotNull
                                                                               TransactionNature nature,
                                                                               org.cyclos.entities.banking.QTransaction t,
                                                                               java.util.Set<? extends java.lang.Enum<?>> statuses,
                                                                               Q query)

Adds a filter by statuses to the given query according to the nature. This method must be used in conjunction with createQuery(TransactionNature, QTransaction, BaseTransactionQuery)

check

void check(LocateAccountOwnerResult from,
           LocateAccountOwnerResult to)

Performs security checks for the given transaction parameters

check

void check(LocateAccountOwnerResult from,
           LocateAccountOwnerResult to,
           TransferType transferType)

Performs security checks for the given transaction parameters, taking into account the current session data channel and principal type

check

void check(PerformInternalTransactionDTO parameters)

Performs security checks for the given transaction parameters

checkIgnoringSessionData

void checkIgnoringSessionData(LocateAccountOwnerResult from,
                              LocateAccountOwnerResult to,
                              TransferType transferType)

Performs security checks for the given transaction parameters, ignoring the current session data channel and principal type

checkPaymentParameters

void checkPaymentParameters(LocateAccountOwnerResult from,
                            LocateAccountOwnerResult to,
                            org.cyclos.impl.banking.PaymentServiceImpl.PaymentOperation paymentOperation,
                            PaymentTransferType paymentType)

Checks that a payment can be performed from / to the given owners, with the given payment type

createQuery

org.cyclos.impl.utils.persistence.DBQuery<?> createQuery(@Nullable
                                                         TransactionNature nature,
                                                         org.cyclos.entities.banking.QTransaction t,
                                                         BaseTransactionQuery params)

Creates a basic query to search transactions. When a nature is given, will force that one. Otherwise, will allow any natures

fill

PaymentTransferType fill(BasePaymentTypeData data,
                         LocateAccountOwnerResult from,
                         LocateAccountOwnerResult to,
                         PaymentTransferType paymentType)

Fills in the given payment type data from / to the given owners, using the given payment type

fill

void fill(Transaction transaction,
          TransactionData data)

Fills a transaction data

fill

void fill(Transaction transaction,
          TransferType type,
          org.cyclos.impl.banking.PaymentServiceImpl.PaymentOperation operation,
          LocateAccountOwnerResult from,
          LocateAccountOwnerResult to,
          java.lang.String fromName,
          java.lang.String toName,
          java.math.BigDecimal amount,
          java.lang.String description,
          java.util.Collection<CustomFieldValueDTO> customValues)

Fills data in a transaction

findByTransactionNumber

Transaction findByTransactionNumber(java.lang.String transactionNumber)

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

isCheckConfirmationPassword

boolean isCheckConfirmationPassword(PaymentTransferType paymentType,
                                    InternalAccountOwner owner,
                                    java.math.BigDecimal amount,
                                    java.util.Date date)

It returns true if the confirmation password must be required according to the channel configuration or if it must not be required (independently of the channel's configuration) because the payment's amount is less than or equal the maximum for a pin-less payment. This method always check the maximum per transaction and (optionally) the maximum per day.

Parameters:

paymentType - the type used for the payment.

the - payer

date - if null then the method will only check the maximum per transaction for a pin-less payment.
Otherwise it will check both maximums: per transaction and per day (for the specified date).
Note: To check the maximum per day for the current day you can use DateHelper.now() as the last parameter.

listPaymentTypes

java.util.List<PaymentTransferType> listPaymentTypes(LocateAccountOwnerResult from,
                                                     LocateAccountOwnerResult to,
                                                     boolean receive)

Returns the possible payment types between the given owners

locateForPayment

LocateAccountOwnerResult locateForPayment(InternalAccountOwner owner)

Locate the receiver when performing a payment using the principal types allowed to perform a payment.

locateForReceiving

LocateAccountOwnerResult locateForReceiving(InternalAccountOwner owner)

Locate the payer when receiving a payment using the principal types allowed to receive a payment.
Additionally, it checks if the BuiltInChannel.POS channel is accessible for the located payer.

persist

void persist(Transaction transaction)

Persists the given transaction and immediately performs additional actions, such as calling the CustomFieldValueHandler.processAfterSave(org.cyclos.entities.system.EntityWithCustomValues) method.

prepareValidation

org.cyclos.impl.banking.TransactionValidationData prepareValidation(org.cyclos.impl.banking.PrepareValidationParameter parameter)

Returns a validator filled with all common validations, plus some other data which was already loaded.

receive

<T> T receive(InternalAccountOwner from,
              java.util.concurrent.Callable<T> action)

Sets up the session data for receiving a transaction from the given user, invoking the given Callable in it.

resolvePaymentType

PaymentTransferType resolvePaymentType(InternalAccountOwner from,
                                       AccountOwner to,
                                       CurrencyVO currency,
                                       Channel channel,
                                       PrincipalType principalType,
                                       org.cyclos.impl.banking.PaymentServiceImpl.PaymentOperation paymentOperation)

Returns the payment type matching the from, to, and optionally, currency according to the given payment operation. If none or more than one exists, returns null.

setStatusAndGetExtensionPoint

<T extends Transaction & HasTransactionStatus<S>,S extends TransactionStatus> org.cyclos.impl.system.ExtensionPointAccessor setStatusAndGetExtensionPoint(T transaction,
                                                                                                                                                          S newStatus)

Creates a ExtensionPointAccessor for a status change, fires the validated event and sets new status

toEntry

TransactionEntryVO toEntry(InternalAccountOwner owner,
                           Transaction transaction)

Converts a transaction to the corresponding entry type

updatePerformAfterPreview

void updatePerformAfterPreview(PerformTransactionDTO dto,
                               LocateAccountOwnerResult from,
                               LocateAccountOwnerResult to,
                               TransferType paymentType)

Updates the given PerformTransactionDTO to make it suitable to be returned again after a preview

validateMinTimeBetweenPayments

void validateMinTimeBetweenPayments(LocateAccountOwnerResult owner,
                                    PaymentTransferType paymentType)

Validates the minimum time between payments

validatePaymentAmount

void validatePaymentAmount(LocateAccountOwnerResult from,
                           LocateAccountOwnerResult to,
                           PaymentTransferType paymentType,
                           java.math.BigDecimal amount,
                           java.util.Date date)

Validates an amount to be paid from the given account