org.cyclos.security.banking

Class ScheduledPaymentServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.banking.ScheduledPaymentServiceSecurity

All Implemented Interfaces:

ScheduledPaymentService, Service

@Security
public class ScheduledPaymentServiceSecurity
extends BaseServiceSecurity
implements ScheduledPaymentService

Security for ScheduledPaymentService

Author:

luis

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 and Description
ScheduledPaymentServiceSecurity()

Method Summary

Modifier and Type	Method and Description
void	block(ScheduledPaymentActionDTO params) Blocks the given scheduled payment, so installments won't be processed on their respective due dates
java.util.List<InstallmentDTO>	calculateInstallments(CalculateInstallmentsDTO dto) Calculates future installments for the given parameters
java.util.List<InstallmentDTO>	calculateInstallmentsReceive(CalculateInstallmentsDTO dto) Calculates future installments for the given parameters on a receive payment
boolean	canCancel(TransactionWithInstallments<?> scheduledPayment)
void	cancel(ScheduledPaymentActionDTO params) Permanently cancels the given scheduled payment, so installments will never be processed
boolean	canProcessInstallments(TransactionWithInstallments<?> scheduledPayment)
boolean	canSettleInstallments(TransactionWithInstallments<?> scheduledPayment)
ScheduledPaymentData	getData(java.lang.Long id) Returns data about a scheduled payment
boolean	isAccessible(ScheduledPayment scheduledPayment)
ScheduledPaymentVO	perform(PerformScheduledPaymentDTO parameters) Performs an scheduled payment, returning its data
ScheduledPaymentPreviewVO	preview(PerformScheduledPaymentDTO parameters) Previews a scheduled payment to be performed
ScheduledPaymentPreviewVO	previewReceive(PerformScheduledPaymentDTO parameters) Previews a scheduled payment to be received
TransferVO	processInstallment(InstallmentActionDTO params) Process the given installment if it's status is not terminal, returning the resulting transfer id
ScheduledPaymentVO	receive(PerformScheduledPaymentDTO parameters) Receives a scheduled payment, returning its data
protected org.cyclos.impl.access.EntityCheck<?>	resolveEntityCheck() Must be implemented in order to return the EntityCheck managed by this security component, or null if none
void	settleInstallment(InstallmentActionDTO params) Marks the given installment status as InstallmentStatus.SETTLED if the status is not terminal.
void	settleRemaining(ScheduledPaymentActionDTO params) Marks all installments whose status is not terminal as InstallmentStatus.SETTLED, and closes the scheduled payment
void	unblock(ScheduledPaymentActionDTO params) Unlocks the given scheduled payment, so installments will be processed on their respective due dates

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkScope, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

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, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

delete, detach, 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

ScheduledPaymentServiceSecurity

public ScheduledPaymentServiceSecurity()

Method Detail

block

public void block(ScheduledPaymentActionDTO params)
           throws FrameworkException

Description copied from interface: ScheduledPaymentService

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

Specified by:

block in interface ScheduledPaymentService

Throws:

FrameworkException

calculateInstallments

public java.util.List<InstallmentDTO> calculateInstallments(CalculateInstallmentsDTO dto)
                                                     throws FrameworkException

Description copied from interface: ScheduledPaymentService

Calculates future installments for the given parameters

Specified by:

calculateInstallments in interface ScheduledPaymentService

Throws:

FrameworkException

calculateInstallmentsReceive

public java.util.List<InstallmentDTO> calculateInstallmentsReceive(CalculateInstallmentsDTO dto)
                                                            throws FrameworkException

Description copied from interface: ScheduledPaymentService

Calculates future installments for the given parameters on a receive payment

Specified by:

calculateInstallmentsReceive in interface ScheduledPaymentService

Throws:

FrameworkException

canCancel

public boolean canCancel(TransactionWithInstallments<?> scheduledPayment)

cancel

public void cancel(ScheduledPaymentActionDTO params)
            throws FrameworkException

Description copied from interface: ScheduledPaymentService

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

Specified by:

cancel in interface ScheduledPaymentService

Throws:

FrameworkException

canProcessInstallments

public boolean canProcessInstallments(TransactionWithInstallments<?> scheduledPayment)

canSettleInstallments

public boolean canSettleInstallments(TransactionWithInstallments<?> scheduledPayment)

getData

public ScheduledPaymentData getData(java.lang.Long id)
                             throws FrameworkException

Description copied from interface: ScheduledPaymentService

Returns data about a scheduled payment

Specified by:

getData in interface ScheduledPaymentService

Throws:

FrameworkException

isAccessible

public boolean isAccessible(ScheduledPayment scheduledPayment)

perform

public ScheduledPaymentVO perform(PerformScheduledPaymentDTO parameters)
                           throws FrameworkException

Description copied from interface: ScheduledPaymentService

Performs an scheduled payment, returning its data

Specified by:

perform in interface ScheduledPaymentService

Throws:

FrameworkException

See Also:

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

preview

public ScheduledPaymentPreviewVO preview(PerformScheduledPaymentDTO parameters)
                                  throws FrameworkException

Description copied from interface: ScheduledPaymentService

Previews a scheduled payment to be performed

Specified by:

preview in interface ScheduledPaymentService

Throws:

FrameworkException

previewReceive

public ScheduledPaymentPreviewVO previewReceive(PerformScheduledPaymentDTO parameters)
                                         throws FrameworkException,
                                                TransferException

Description copied from interface: ScheduledPaymentService

Previews a scheduled payment to be received

Specified by:

previewReceive in interface ScheduledPaymentService

Throws:

FrameworkException

TransferException

processInstallment

public TransferVO processInstallment(InstallmentActionDTO params)
                              throws FrameworkException,
                                     TransferException

Description copied from interface: ScheduledPaymentService

Process the given installment if it's status is not terminal, returning the resulting transfer id

Specified by:

processInstallment in interface ScheduledPaymentService

Throws:

FrameworkException

TransferException

See Also:

InstallmentStatus.isTerminal()

receive

public ScheduledPaymentVO receive(PerformScheduledPaymentDTO parameters)
                           throws FrameworkException,
                                  TransferException

Description copied from interface: ScheduledPaymentService

Receives a scheduled payment, returning its data

Specified by:

receive in interface ScheduledPaymentService

Throws:

FrameworkException

TransferException

See Also:

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

settleInstallment

public void settleInstallment(InstallmentActionDTO params)
                       throws FrameworkException,
                              TransferException

Description copied from interface: ScheduledPaymentService

Marks the given installment status as InstallmentStatus.SETTLED if the status is not terminal.

Specified by:

settleInstallment in interface ScheduledPaymentService

Throws:

FrameworkException

TransferException

See Also:

InstallmentStatus.isTerminal()

settleRemaining

public void settleRemaining(ScheduledPaymentActionDTO params)
                     throws FrameworkException,
                            TransferException

Description copied from interface: ScheduledPaymentService

Marks all installments whose status is not terminal as InstallmentStatus.SETTLED, and closes the scheduled payment

Specified by:

settleRemaining in interface ScheduledPaymentService

Throws:

FrameworkException

TransferException

See Also:

InstallmentStatus.isTerminal()

unblock

public void unblock(ScheduledPaymentActionDTO params)
             throws FrameworkException

Description copied from interface: ScheduledPaymentService

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

Specified by:

unblock in interface ScheduledPaymentService

Throws:

FrameworkException

resolveEntityCheck

protected org.cyclos.impl.access.EntityCheck<?> resolveEntityCheck()

Description copied from class: BaseServiceSecurity

Must be implemented in order to return the EntityCheck managed by this security component, or null if none

Specified by:

resolveEntityCheck in class BaseServiceSecurity