TransactionWithInstallments (Cyclos 4.15.15 Scripting API Documentation)

All Superinterfaces:

HasAmount, HasCurrency, HasCurrencyAmount, HasTransactionNumber, IEntity, Trans

All Known Implementing Classes:

RecurringPayment, ScheduledPayment
```
public interface TransactionWithInstallments<I extends Installment>
extends Trans
```
A transaction that has installments

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default I`	`getFirstScheduledInstallment()`	Returns the first installment whose status is `InstallmentStatus.SCHEDULED`
`List<I>`	`getInstallments()`
`default Integer`	`getInstallmentsCount()`
`default I`	`getLastProcessedInstallment()`	Returns the last installment whose status matches `isProcessed(Installment)`
`default int`	`getProcessedInstallments()`	Returns the number of installments whose status matches `isProcessed(Installment)`
`default String`	`getScheduling()`	Returns a string with an overview of the scheduling: if there's a total installments count, returns `getProcessedInstallments()` + "/" + `getInstallmentsCount()`.
`default String`	`getScheduling(int processed)`	Returns a string with an overview of the scheduling: if there's a total installments count, returns processed + "/" + `getInstallmentsCount()`.
`static boolean`	`isProcessed(Installment installment)`	Returns whether the installment status is either `InstallmentStatus.PROCESSED`, `InstallmentStatus.SETTLED` or `InstallmentStatus.FAILED`.

Methods inherited from interface org.cyclos.utils.HasAmount
setAmount

Methods inherited from interface org.cyclos.entities.banking.HasCurrency
getCurrency, round, withCurrency

Methods inherited from interface org.cyclos.entities.banking.HasCurrencyAmount
getCurrencyAmount

Methods inherited from interface org.cyclos.model.banking.transactions.HasTransactionNumber
getTransactionNumber

Methods inherited from interface org.cyclos.model.IEntity
getId, matches

Methods inherited from interface org.cyclos.entities.banking.Trans
getAccessClient, getActualAmount, getAmount, getChannel, getCustomValues, getDate, getFrom, getFromName, getFromOwner, getFromOwnerOrType, getFromType, getFromUser, getRelatedAccount, getRelatedOwner, getTo, getToName, getToOwner, getToOwnerOrType, getToType, getToUser, getTransactionNumberOrId, getType, isDebit, isFromSystem, isFromUser, isToSystem, isToUser

- Method Detail
  - isProcessed
```
static boolean isProcessed(Installment installment)
```
    Returns whether the installment status is either InstallmentStatus.PROCESSED, InstallmentStatus.SETTLED or InstallmentStatus.FAILED.
  - getFirstScheduledInstallment
```
default I getFirstScheduledInstallment()
```
    Returns the first installment whose status is InstallmentStatus.SCHEDULED
  - getInstallments
```
List<I> getInstallments()
```
  - getInstallmentsCount
```
default Integer getInstallmentsCount()
```
  - getLastProcessedInstallment
```
default I getLastProcessedInstallment()
```
    Returns the last installment whose status matches isProcessed(Installment)
  - getProcessedInstallments
```
default int getProcessedInstallments()
```
    Returns the number of installments whose status matches isProcessed(Installment)
  - getScheduling
```
default String getScheduling()
```
    Returns a string with an overview of the scheduling: if there's a total installments count, returns getProcessedInstallments() + "/" + getInstallmentsCount(). Otherwise, returns just getProcessedInstallments();
  - getScheduling
```
default String getScheduling(int processed)
```
    Returns a string with an overview of the scheduling: if there's a total installments count, returns processed + "/" + getInstallmentsCount(). Otherwise, returns just processed.