Package org.cyclos.impl.banking

Interface TransactionServiceLocal

All Superinterfaces:

Service, TransactionService

All Known Implementing Classes:

TransactionServiceImpl

public interface TransactionServiceLocal
extends TransactionService

Local interface for TransactionService

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_AUTHORIZATION_LEVEL	Script bind variable: the AuthorizationLevel (if the payment would be authorized with a level)
static String	ATTR_AUTHORIZATION_TYPE	Script bind variable: the TransactionAuthorizationType (if the payment would be authorized)
static String	ATTR_FROM_ACCOUNT	Script bind variable: the from Account
static String	ATTR_FROM_OWNER	Script bind variable: the InternalAccountOwner from
static String	ATTR_FROM_OWNER_RESULT	Script bind variable: the LocateAccountOwnerResult of the from
static String	ATTR_INSTALLMENT	Script bind variable: the Installment
static String	ATTR_NEW_STATUS	Script bind variable: the new status
static String	ATTR_OLD_STATUS	Script bind variable: the old status
static String	ATTR_PAYMENT_TYPE	Script bind variable: the PaymentTransferType
static String	ATTR_PERFORM_TRANSACTION	Script bind variable: the PerformTransactionDTO
static String	ATTR_PREVIEW	Script bind variable: the PaymentPreviewVO
static String	ATTR_TO_ACCOUNT	Script bind variable: the to Account
static String	ATTR_TO_OWNER	Script bind variable: the AccountOwner to
static String	ATTR_TO_OWNER_RESULT	Script bind variable: the LocateAccountOwnerResult of the to
static String	ATTR_TRANSACTION	Script bind variable: the Transaction (only available in the TransactionExtensionPointEvent.CONFIRM event, on the validated phase)
static String	FOR_POS	Bean attribute to indicate a PerformInternalTransactionDTO as used for POS

Method Summary

Modifier and Type	Method	Description
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, PaymentCreationType creationType, PaymentTransferType paymentType)	Checks that a payment can be performed from / to the given owners, with the given payment type
OperatorVO	convertToOperatorVO(Operator operator)	If it's a user trying to viewing another user operator returns the display of the operator and the user.
<D extends TransactionData> D	fill(D data, Transaction transaction)	Fills a data instance with basic data
void	fill(Transaction transaction, TransferType type, PaymentCreationType creationType, Account from, Account to, BasicUser receiver, String fromName, String toName, BigDecimal amount, String description, Collection<CustomFieldValueDTO> customValues)	Fills data in a transaction
PaymentTransferType	fill(AbstractPaymentTypeData data, LocateAccountOwnerResult from, LocateAccountOwnerResult to, PaymentTransferType paymentType)	Fills in the given payment type data from / to the given owners, using the given payment type
Transaction	findByTransactionNumber(String transactionNumber)	Returns a transaction by transaction number, or throws EntityNotFoundException if not found
Map<String,Object>	getCustomFieldValidationBindings(LocateAccountOwnerResult from, LocateAccountOwnerResult to, PaymentTransferType tt)	Returns a map to be used as bindings on dynamic custom field validation
Transaction	getGeneratedBy(Transaction transaction)	Returns the transaction that generated the given transaction
Set<TransactionNature>	getVisibleNatures(InternalAccountOwner owner)	Returns the visible transaction natures for the logged user over the given optional owner.
boolean	isAccessible(InternalAccountOwner owner, TransactionNature nature)	Returns whether the logged user has basic accessibility for transactions of the given nature for the given owner.
boolean	isCheckConfirmationPassword(PaymentTransferType paymentType, InternalAccountOwner owner, BigDecimal amount, Date date)	It returns true if the confirmation password must be required because the payment's amount is greater than or equals to the maximum for a pin-less payment.
boolean	isVisible(InternalAccountOwner owner, TransactionNature nature)	Returns whether the logged user can see transactions of the given nature for the given optional owner.
List<PaymentTransferType>	listPaymentTypes(LocateAccountOwnerResult from, LocateAccountOwnerResult to, Currency currency, boolean receive)	Returns the possible payment, optionally in a currency, 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.
<D extends TransactionData> D	newData(Transaction transaction)	Returns a new instance of the Data for the specific transaction, filled-in with basic data
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(PrepareValidationParameter parameter)	Returns a validator filled with all common validations, plus some other data which was already loaded.
<T> T	receive(InternalAccountOwner from, 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, Currency currency, Channel channel, PrincipalType principalType, PaymentCreationType creationType)	Returns the payment type matching the from, to, and optionally, currency according to the given payment operation.
ExtensionPointAccessor	setStatusAndGetExtensionPoint(Installment installment, InstallmentStatus newStatus)	Creates a ExtensionPointAccessor for a status change, fires the validated event and sets new status
<T extends Transaction & HasTransactionStatus<S>,S extends TransactionStatus> ExtensionPointAccessor	setStatusAndGetExtensionPoint(T transaction, S newStatus)	Creates a ExtensionPointAccessor for a status change, fires the validated event and sets new status
void	updatePreviewAndPayment(BasePaymentPreviewVO preview, PerformTransactionDTO dto, LocateAccountOwnerResult from, LocateAccountOwnerResult to, TransferType paymentType, SessionData receiverSessionData)	Updates the given preview BasePaymentPreviewVO and set the given paymentDTO PerformTransactionDTO after 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, BigDecimal amount, Date date)	Validates an amount to be paid from the given account.

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

createDeviceConfirmationForReceive, deviceConfirmationBarcodeForReceive, exportInstallments, exportInstallmentsOverview, exportOverview, exportTransaction, exportTransactions, getData, getInstallmentsOverviewSearchData, getInstallmentsSearchData, getMaturityTable, getOverviewSearchData, getPaymentData, getPaymentToOwnerData, getPaymentTypeData, getReceivePaymentData, getReceivePaymentFromUserData, getReceivePaymentTypeData, getSearchData, load, loadByTransactionNumber, processInstallment, removeDeviceConfirmationForReceive, requestNewOTPForReceive, search, searchInstallments, searchInstallmentsOverview, searchOverview, settleInstallment, viewDeviceConfirmationForReceive

Field Detail

FOR_POS

static final String FOR_POS

Bean attribute to indicate a PerformInternalTransactionDTO as used for POS

See Also:

Constant Field Values

ATTR_PERFORM_TRANSACTION

static final String ATTR_PERFORM_TRANSACTION

Script bind variable: the PerformTransactionDTO

See Also:

Constant Field Values

ATTR_TRANSACTION

static final 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_INSTALLMENT

static final String ATTR_INSTALLMENT

Script bind variable: the Installment

See Also:

Constant Field Values

ATTR_PREVIEW

static final String ATTR_PREVIEW

Script bind variable: the PaymentPreviewVO

See Also:

Constant Field Values

ATTR_PAYMENT_TYPE

static final String ATTR_PAYMENT_TYPE

Script bind variable: the PaymentTransferType

See Also:

Constant Field Values

ATTR_FROM_ACCOUNT

static final String ATTR_FROM_ACCOUNT

Script bind variable: the from Account

See Also:

Constant Field Values

ATTR_TO_ACCOUNT

static final String ATTR_TO_ACCOUNT

Script bind variable: the to Account

See Also:

Constant Field Values

ATTR_FROM_OWNER

static final String ATTR_FROM_OWNER

Script bind variable: the InternalAccountOwner from

See Also:

Constant Field Values

ATTR_TO_OWNER

static final String ATTR_TO_OWNER

Script bind variable: the AccountOwner to

See Also:

Constant Field Values

ATTR_FROM_OWNER_RESULT

static final String ATTR_FROM_OWNER_RESULT

Script bind variable: the LocateAccountOwnerResult of the from

See Also:

Constant Field Values

ATTR_TO_OWNER_RESULT

static final String ATTR_TO_OWNER_RESULT

Script bind variable: the LocateAccountOwnerResult of the to

See Also:

Constant Field Values

ATTR_AUTHORIZATION_TYPE

static final String ATTR_AUTHORIZATION_TYPE

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

See Also:

Constant Field Values

ATTR_AUTHORIZATION_LEVEL

static final String ATTR_AUTHORIZATION_LEVEL

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

See Also:

Constant Field Values

ATTR_OLD_STATUS

static final String ATTR_OLD_STATUS

Script bind variable: the old status

See Also:

Constant Field Values

ATTR_NEW_STATUS

static final String ATTR_NEW_STATUS

Script bind variable: the new status

See Also:

Constant Field Values

Method Detail

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,
                            PaymentCreationType creationType,
                            PaymentTransferType paymentType)

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

convertToOperatorVO

OperatorVO convertToOperatorVO(Operator operator)

If it's a user trying to viewing another user operator returns the display of the operator and the user. Otherwise it use BasicUserVOConverter. If the logged user is not related to the operator returns null; This code is relying in BasicUserVOConverter management for operators.

fill

PaymentTransferType fill(AbstractPaymentTypeData 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

<D extends TransactionData> D fill(D data,
                                   Transaction transaction)

Fills a data instance with basic data

fill

void fill(Transaction transaction,
          TransferType type,
          PaymentCreationType creationType,
          Account from,
          Account to,
          BasicUser receiver,
          String fromName,
          String toName,
          BigDecimal amount,
          String description,
          Collection<CustomFieldValueDTO> customValues)

Fills data in a transaction

findByTransactionNumber

Transaction findByTransactionNumber(String transactionNumber)

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

getCustomFieldValidationBindings

Map<String,Object> getCustomFieldValidationBindings(LocateAccountOwnerResult from,
                                                          LocateAccountOwnerResult to,
                                                          PaymentTransferType tt)

Returns a map to be used as bindings on dynamic custom field validation

getGeneratedBy

Transaction getGeneratedBy(Transaction transaction)

Returns the transaction that generated the given transaction

getVisibleNatures

Set<TransactionNature> getVisibleNatures(InternalAccountOwner owner)

Returns the visible transaction natures for the logged user over the given optional owner. When no owner is given, returns whether can view transactions of that nature, regardless of the owner.

isAccessible

boolean isAccessible(InternalAccountOwner owner,
                     TransactionNature nature)

Returns whether the logged user has basic accessibility for transactions of the given nature for the given owner. When no owner is given, assumes the current user's owner. The basic difference between view and access is that access doesn't check any view permission for own transactions.

isCheckConfirmationPassword

boolean isCheckConfirmationPassword(PaymentTransferType paymentType,
                                    InternalAccountOwner owner,
                                    BigDecimal amount,
                                    Date date)

It returns true if the confirmation password must be required because the payment's amount is greater than or equals to 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.

isVisible

boolean isVisible(InternalAccountOwner owner,
                  TransactionNature nature)

Returns whether the logged user can see transactions of the given nature for the given optional owner. When no owner is given, returns whether can view transactions of that nature, regardless of the owner.

listPaymentTypes

List<PaymentTransferType> listPaymentTypes(LocateAccountOwnerResult from,
                                           LocateAccountOwnerResult to,
                                           Currency currency,
                                           boolean receive)

Returns the possible payment, optionally in a currency, 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.

newData

<D extends TransactionData> D newData(Transaction transaction)

Returns a new instance of the Data for the specific transaction, filled-in with basic data

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(PrepareValidationParameter parameter)

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

receive

<T> T receive(InternalAccountOwner from,
              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,
                                       Currency currency,
                                       Channel channel,
                                       PrincipalType principalType,
                                       PaymentCreationType creationType)

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

ExtensionPointAccessor setStatusAndGetExtensionPoint(Installment installment,
                                                     InstallmentStatus newStatus)

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

setStatusAndGetExtensionPoint

<T extends Transaction & HasTransactionStatus<S>,S extends TransactionStatus> ExtensionPointAccessor setStatusAndGetExtensionPoint(T transaction,
                                                                                                                                         S newStatus)

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

updatePreviewAndPayment

void updatePreviewAndPayment(BasePaymentPreviewVO preview,
                             PerformTransactionDTO dto,
                             LocateAccountOwnerResult from,
                             LocateAccountOwnerResult to,
                             TransferType paymentType,
                             SessionData receiverSessionData)

Updates the given preview BasePaymentPreviewVO and set the given paymentDTO PerformTransactionDTO after 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,
                           BigDecimal amount,
                           Date date)

Validates an amount to be paid from the given account.