Package org.cyclos.impl.banking

Class RecurringPaymentServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.banking.RecurringPaymentServiceImpl

All Implemented Interfaces:

RecurringPaymentServiceLocal, RecurringPaymentService, Service

@Service
public class RecurringPaymentServiceImpl
extends BaseServiceImpl
implements RecurringPaymentServiceLocal

Implementation for RecurringPaymentService

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
RecurringPaymentServiceImpl()

Method Summary

Modifier and Type	Method	Description
RecurringPayment	acceptPaymentRequest(PaymentRequest paymentRequest)	Generates the recurring payment for accepting a payment request, which must be open and recurring
void	block(RecurringPaymentActionDTO params)	Blocks the given recurring payment, so installments won't be processed on their respective due dates
void	cancel(RecurringPaymentActionDTO params)	Permanently cancels the given recurring payment, so installments will never be processed
int	cancelAll(UserAccount account)	Cancels all recurring payments to or from the given account
RecurringPaymentData	getData(Long id)	Returns data about a recurring payment
RecurringPaymentEditData	getEditData(@NotNull RecurringPaymentVO vo)	Returns data for edition about a recurring payment
void	initialize()
void	markAsFailed(RecurringPaymentOccurrence occurrence)	Marks the given occurrence as failed, notifying the involved parties
void	modify(RecurringPaymentDTO dto, String confirmationPassword)	Modifies the given recurring payment
void	notifyPaymentPerformed(RecurringPayment recurringPayment)	Send all notifications derived from to a recurring payment creation E.g notifies the receiving user if the recurring payment is visible, and not generated from a payment request (as it is already notified)
RecurringPaymentVO	perform(PerformRecurringPaymentDTO parameters)	Performs an recurring payment, returning its data
RecurringPaymentPreviewVO	preview(PerformRecurringPaymentDTO parameters)	Previews a recurring payment to be performed
RecurringPaymentPreviewVO	previewAcceptPaymentRequest(PaymentRequest paymentRequest)	Previews accepting the given payment request, which must be open and recurring
RecurringPaymentPreviewVO	previewReceive(PerformRecurringPaymentDTO parameters)	Previews a recurring payment to be received
TransferVO	processFailure(@NotNull InstallmentActionDTO params)	Processes a failed occurrence
InstallmentTransfer	processFailure(RecurringPaymentOccurrence failure)	Process the given failure, returning the root generated transfer
InstallmentTransfer	processOccurrence(RecurringPaymentOccurrence occurrence)	Processes the recurring payment occurrence, generating a transfer
RecurringPaymentVO	receive(PerformRecurringPaymentDTO parameters)	Receives a recurring payment, returning its data
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	unblock(RecurringPaymentActionDTO params)	Unlocks the given recurring payment, so installments will be processed on their respective due dates

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecurringPaymentServiceImpl

public RecurringPaymentServiceImpl()

Method Detail

acceptPaymentRequest

public RecurringPayment acceptPaymentRequest(PaymentRequest paymentRequest)

Description copied from interface: RecurringPaymentServiceLocal

Generates the recurring payment for accepting a payment request, which must be open and recurring

Specified by:

acceptPaymentRequest in interface RecurringPaymentServiceLocal

block

public void block(RecurringPaymentActionDTO params)
           throws FrameworkException

Description copied from interface: RecurringPaymentService

Blocks the given recurring payment, so installments won't be processed on their respective due dates

Specified by:

block in interface RecurringPaymentService

Throws:

FrameworkException

cancel

public void cancel(RecurringPaymentActionDTO params)
            throws FrameworkException

Description copied from interface: RecurringPaymentService

Permanently cancels the given recurring payment, so installments will never be processed

Specified by:

cancel in interface RecurringPaymentService

Throws:

FrameworkException

cancelAll

public int cancelAll(UserAccount account)

Description copied from interface: RecurringPaymentServiceLocal

Cancels all recurring payments to or from the given account

Specified by:

cancelAll in interface RecurringPaymentServiceLocal

getData

public RecurringPaymentData getData(Long id)
                             throws FrameworkException

Description copied from interface: RecurringPaymentService

Returns data about a recurring payment

Specified by:

getData in interface RecurringPaymentService

Throws:

FrameworkException

getEditData

public RecurringPaymentEditData getEditData(@NotNull
                                            @NotNull RecurringPaymentVO vo)
                                     throws FrameworkException

Description copied from interface: RecurringPaymentService

Returns data for edition about a recurring payment

Specified by:

getEditData in interface RecurringPaymentService

Throws:

FrameworkException

initialize

@PostConstruct
public void initialize()

markAsFailed

public void markAsFailed(RecurringPaymentOccurrence occurrence)

Description copied from interface: RecurringPaymentServiceLocal

Marks the given occurrence as failed, notifying the involved parties

Specified by:

markAsFailed in interface RecurringPaymentServiceLocal

modify

public void modify(RecurringPaymentDTO dto,
                   String confirmationPassword)
            throws FrameworkException

Description copied from interface: RecurringPaymentService

Modifies the given recurring payment

Specified by:

modify in interface RecurringPaymentService

Throws:

FrameworkException

notifyPaymentPerformed

public void notifyPaymentPerformed(RecurringPayment recurringPayment)

Description copied from interface: RecurringPaymentServiceLocal

Send all notifications derived from to a recurring payment creation E.g notifies the receiving user if the recurring payment is visible, and not generated from a payment request (as it is already notified)

Specified by:

notifyPaymentPerformed in interface RecurringPaymentServiceLocal

perform

public RecurringPaymentVO perform(PerformRecurringPaymentDTO parameters)
                           throws FrameworkException

Description copied from interface: RecurringPaymentService

Performs an recurring payment, returning its data

Specified by:

perform in interface RecurringPaymentService

Throws:

FrameworkException

See Also:

PaymentService.perform(org.cyclos.model.banking.transactions.PerformPaymentDTO)

preview

public RecurringPaymentPreviewVO preview(PerformRecurringPaymentDTO parameters)
                                  throws FrameworkException

Description copied from interface: RecurringPaymentService

Previews a recurring payment to be performed

Specified by:

preview in interface RecurringPaymentService

Throws:

FrameworkException

previewAcceptPaymentRequest

public RecurringPaymentPreviewVO previewAcceptPaymentRequest(PaymentRequest paymentRequest)

Description copied from interface: RecurringPaymentServiceLocal

Previews accepting the given payment request, which must be open and recurring

Specified by:

previewAcceptPaymentRequest in interface RecurringPaymentServiceLocal

previewReceive

public RecurringPaymentPreviewVO previewReceive(PerformRecurringPaymentDTO parameters)
                                         throws FrameworkException,
                                                TransferException

Description copied from interface: RecurringPaymentService

Previews a recurring payment to be received

Specified by:

previewReceive in interface RecurringPaymentService

Throws:

FrameworkException

TransferException

processFailure

public TransferVO processFailure(@NotNull
                                 @NotNull InstallmentActionDTO params)
                          throws FrameworkException,
                                 TransferException

Description copied from interface: RecurringPaymentService

Processes a failed occurrence

Specified by:

processFailure in interface RecurringPaymentService

Throws:

FrameworkException

TransferException

processFailure

public InstallmentTransfer processFailure(RecurringPaymentOccurrence failure)

Description copied from interface: RecurringPaymentServiceLocal

Process the given failure, returning the root generated transfer

Specified by:

processFailure in interface RecurringPaymentServiceLocal

processOccurrence

public InstallmentTransfer processOccurrence(RecurringPaymentOccurrence occurrence)

Description copied from interface: RecurringPaymentServiceLocal

Processes the recurring payment occurrence, generating a transfer

Specified by:

processOccurrence in interface RecurringPaymentServiceLocal

receive

public RecurringPaymentVO receive(PerformRecurringPaymentDTO parameters)
                           throws FrameworkException,
                                  TransferException

Description copied from interface: RecurringPaymentService

Receives a recurring payment, returning its data

Specified by:

receive in interface RecurringPaymentService

Throws:

FrameworkException

TransferException

See Also:

PaymentService.perform(org.cyclos.model.banking.transactions.PerformPaymentDTO)

unblock

public void unblock(RecurringPaymentActionDTO params)
             throws FrameworkException

Description copied from interface: RecurringPaymentService

Unlocks the given recurring payment, so installments will be processed on their respective due dates

Specified by:

unblock in interface RecurringPaymentService

Throws:

FrameworkException

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl