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 AccountOwner 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_TRANSACTION Script bind variable: the Transaction (only available in the TransactionExtensionPointEvent.CONFIRM event, on the validated phase)

Method Summary

Methods

Modifier and Type	Method and Description
void	addStaticAmountValidations(org.cyclos.impl.utils.validation.Validator validator, PaymentTransferType transferType, PerformTransactionDTO dto) Add static amount validations
void	checkPaymentParameters(AccountOwner from, AccountOwner to, boolean forPaymentRequest, 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, org.cyclos.entities.banking.QPaymentTransferType tt, BaseTransactionQuery params) Creates a basic query to search transactions.
PaymentTransferType	fill(BasePaymentTypeData data, AccountOwner from, AccountOwner to, java.lang.Long paymentTypeId) 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, AccountOwner from, AccountOwner to, java.math.BigDecimal amount, java.lang.String description) Fills data in a transaction
Transaction	findByTransactionNumber(java.lang.String transactionNumber) Returns a transaction by transaction number, or throws EntityNotFoundException if not found
boolean	hasTransactions(java.util.Set<UserAccountType> userAccounts, java.util.Set<Group> groups) Returns true if there is at least one transaction of a user that belongs to any of the given groups performed from or to any of the given user accounts.
boolean	isCheckConfirmationPassword(PaymentTransferType paymentType, AccountOwner 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.
org.cyclos.impl.banking.TransactionValidationData	prepareValidation(PerformTransactionDTO dto, boolean ignoreChannelForPaymentType, boolean allowSearchingTTWhenNoneIsGiven, boolean validateConfirmationPassword, boolean excludeHideInForm, boolean validateNFCChallenge) Returns a validator filled with all common validations, plus some other data which was already loaded.
<T> T	receive(AccountOwner from, PrincipalType principalType, 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.
TransactionEntryVO	toEntry(AccountOwner owner, Transaction transaction) Converts a transaction to the corresponding entry type
void	validatePaymentAmount(AccountOwner from, AccountOwner 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

getPaymentData, getPaymentToOwnerData, getPaymentTypeData, getReceivePaymentData, getReceivePaymentFromUserData, getReceivePaymentTypeData, getSearchData, load, loadByTransactionNumber, print, 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 AccountOwner 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_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

addStaticAmountValidations

void addStaticAmountValidations(org.cyclos.impl.utils.validation.Validator validator,
                              PaymentTransferType transferType,
                              PerformTransactionDTO dto)

Add static amount validations

checkPaymentParameters

void checkPaymentParameters(AccountOwner from,
                          AccountOwner to,
                          boolean forPaymentRequest,
                          PaymentTransferType paymentType)
                            throws FrameworkException

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

Throws:

FrameworkException

createQuery

org.cyclos.impl.utils.persistence.DBQuery createQuery(@Nullable
                                                    TransactionNature nature,
                                                    org.cyclos.entities.banking.QTransaction t,
                                                    org.cyclos.entities.banking.QPaymentTransferType tt,
                                                    BaseTransactionQuery params)
                                                      throws FrameworkException

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

Throws:

FrameworkException

fill

PaymentTransferType fill(BasePaymentTypeData data,
                       AccountOwner from,
                       AccountOwner to,
                       java.lang.Long paymentTypeId)
                         throws FrameworkException

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

Throws:

FrameworkException

fill

void fill(Transaction transaction,
        TransactionData data)
          throws FrameworkException

Fills a transaction data

Throws:

FrameworkException

fill

void fill(Transaction transaction,
        TransferType type,
        AccountOwner from,
        AccountOwner to,
        java.math.BigDecimal amount,
        java.lang.String description)
          throws FrameworkException

Fills data in a transaction

Throws:

FrameworkException

findByTransactionNumber

Transaction findByTransactionNumber(java.lang.String transactionNumber)
                                    throws FrameworkException

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

Throws:

FrameworkException

hasTransactions

boolean hasTransactions(java.util.Set<UserAccountType> userAccounts,
                      java.util.Set<Group> groups)

Returns true if there is at least one transaction of a user that belongs to any of the given groups performed from or to any of the given user accounts.

isCheckConfirmationPassword

boolean isCheckConfirmationPassword(PaymentTransferType paymentType,
                                  AccountOwner 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.

prepareValidation

org.cyclos.impl.banking.TransactionValidationData prepareValidation(PerformTransactionDTO dto,
                                                                  boolean ignoreChannelForPaymentType,
                                                                  boolean allowSearchingTTWhenNoneIsGiven,
                                                                  boolean validateConfirmationPassword,
                                                                  boolean excludeHideInForm,
                                                                  boolean validateNFCChallenge)
                                                                    throws FrameworkException

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

Parameters:

validateNFCChallenge - only taken into account if the payer was located by a NFC token.

Throws:

FrameworkException

receive

<T> T receive(AccountOwner from,
            PrincipalType principalType,
            java.util.concurrent.Callable<T> action)
          throws FrameworkException

Sets up the session data for receiving a transaction from the given user, invoking the given callable in it. PrincipalType may be null

Throws:

FrameworkException

toEntry

TransactionEntryVO toEntry(AccountOwner owner,
                         Transaction transaction)
                           throws FrameworkException

Converts a transaction to the corresponding entry type

Throws:

FrameworkException

validatePaymentAmount

void validatePaymentAmount(AccountOwner from,
                         AccountOwner to,
                         PaymentTransferType paymentType,
                         java.math.BigDecimal amount,
                         java.util.Date date)
                           throws FrameworkException,
                                  TransferException

Validates an amount to be paid from the given account

Throws:

FrameworkException

TransferException