RecurringPaymentServiceLocal (Cyclos 4.15.15 Scripting API Documentation)

All Superinterfaces:

RecurringPaymentService, Service

All Known Implementing Classes:

RecurringPaymentServiceImpl
```
public interface RecurringPaymentServiceLocal
extends RecurringPaymentService
```
Local interface for RecurringPaymentService

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`RecurringPayment`	`acceptPaymentRequest(PaymentRequest paymentRequest)`	Generates the recurring payment for accepting a payment request, which must be open and recurring
`int`	`cancelAll(UserAccount account)`	Cancels all recurring payments to or from the given account
`void`	`markAsFailed(RecurringPaymentOccurrence occurrence)`	Marks the given occurrence as failed, notifying the involved parties
`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)
`RecurringPaymentPreviewVO`	`previewAcceptPaymentRequest(PaymentRequest paymentRequest)`	Previews accepting the given payment request, which must be open and recurring
`InstallmentTransfer`	`processFailure(RecurringPaymentOccurrence occurrence)`	Process the given failure, returning the root generated transfer
`InstallmentTransfer`	`processOccurrence(RecurringPaymentOccurrence occurrence)`	Processes the recurring payment occurrence, generating a transfer

Methods inherited from interface org.cyclos.services.banking.RecurringPaymentService
block, cancel, getData, getEditData, modify, perform, preview, previewReceive, processFailure, receive, unblock

- Method Detail
  - acceptPaymentRequest
```
RecurringPayment acceptPaymentRequest(PaymentRequest paymentRequest)
```
    Generates the recurring payment for accepting a payment request, which must be open and recurring
  - cancelAll
```
int cancelAll(UserAccount account)
```
    Cancels all recurring payments to or from the given account
  - markAsFailed
```
void markAsFailed(RecurringPaymentOccurrence occurrence)
```
    Marks the given occurrence as failed, notifying the involved parties
  - notifyPaymentPerformed
```
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)
  - previewAcceptPaymentRequest
```
RecurringPaymentPreviewVO previewAcceptPaymentRequest(PaymentRequest paymentRequest)
```
    Previews accepting the given payment request, which must be open and recurring
  - processFailure
```
InstallmentTransfer processFailure(RecurringPaymentOccurrence occurrence)
```
    Process the given failure, returning the root generated transfer
    
    Throws:
    
    IllegalActionException - If the failure is already processed
  - processOccurrence
```
InstallmentTransfer processOccurrence(RecurringPaymentOccurrence occurrence)
```
    Processes the recurring payment occurrence, generating a transfer