Package org.cyclos.entities.banking

Interface Trans

All Superinterfaces:

HasAmount, HasCurrency, HasCurrencyAmount, HasTransactionNumber, IEntity, ProcessableForProxying

All Known Subinterfaces:

TransactionWithInstallments<I>

All Known Implementing Classes:

AccountFeeTransfer, AccountHistoryEntry, BalanceDisposalTransfer, BasePayment, ChargebackTransfer, ExternalPayment, ImportTransaction, ImportTransfer, InitialCreditTransfer, Installment, InstallmentTransfer, InternalTransaction, Payment, PaymentRequest, PaymentTransfer, RecurringPayment, RecurringPaymentOccurrence, ScheduledPayment, ScheduledPaymentInstallment, Ticket, Transaction, Transfer, TransferFeeTransfer, TransWrapper

public interface Trans
extends HasTransactionNumber, HasCurrencyAmount, ProcessableForProxying

Common interface for transfers and transactions

Method Summary

Modifier and Type	Method	Description
AccessClient	getAccessClient()
default BigDecimal	getActualAmount(InternalAccountOwner owner)
BigDecimal	getAmount()
Channel	getChannel()
Set<TransactionCustomFieldValue>	getCustomValues()
default Set<TransactionCustomFieldValue>	getCustomValuesForExport()	This method is invoked when exporting / indexing the visible custom fields. For some kind of transfers we need access to the transaction's custom values (e.g TransferFeeTransfer) without exposing the other data own by the Transaction (by, receivedBy, etc) The default implementation return the same as getCustomValues()
Date	getDate()
Account	getFrom()
String	getFromName()
default InternalAccountOwner	getFromOwner()
default Object	getFromOwnerOrType()	When from a user, returns the user.
default AccountType	getFromType()
default User	getFromUser()
default Account	getRelatedAccount(InternalAccountOwner owner)
default AccountOwner	getRelatedOwner(InternalAccountOwner owner)
Account	getTo()
String	getToName()
default AccountOwner	getToOwner()
default Object	getToOwnerOrType()	When to a user, returns the user.
default AccountType	getToType()
default User	getToUser()
default String	getTransactionNumberOrId()
TransferType	getType()
default boolean	isDebit(InternalAccountOwner owner)
default boolean	isFromSystem()
default boolean	isFromUser()
default boolean	isToSystem()
default boolean	isToUser()

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.ProcessableForProxying

getProxyClass

Method Detail

getAccessClient

AccessClient getAccessClient()

getActualAmount

default BigDecimal getActualAmount(InternalAccountOwner owner)

getAmount

BigDecimal getAmount()

Specified by:

getAmount in interface HasAmount

getChannel

Channel getChannel()

getCustomValues

Set<TransactionCustomFieldValue> getCustomValues()

getCustomValuesForExport

default Set<TransactionCustomFieldValue> getCustomValuesForExport()

This method is invoked when exporting / indexing the visible custom fields.
For some kind of transfers we need access to the transaction's custom values (e.g TransferFeeTransfer) without exposing the other data own by the Transaction (by, receivedBy, etc) The default implementation return the same as getCustomValues()

getDate

Date getDate()

getFrom

Account getFrom()

getFromName

String getFromName()

getFromOwner

default InternalAccountOwner getFromOwner()

getFromOwnerOrType

default Object getFromOwnerOrType()

When from a user, returns the user. When from system, returns the system account type.

getFromType

default AccountType getFromType()

getFromUser

default User getFromUser()

getRelatedAccount

default Account getRelatedAccount(InternalAccountOwner owner)

getRelatedOwner

default AccountOwner getRelatedOwner(InternalAccountOwner owner)

getTo

Account getTo()

getToName

String getToName()

getToOwner

default AccountOwner getToOwner()

getToOwnerOrType

default Object getToOwnerOrType()

When to a user, returns the user. When to system, returns the system account type.

getToType

default AccountType getToType()

getToUser

default User getToUser()

getTransactionNumberOrId

default String getTransactionNumberOrId()

getType

TransferType getType()

isDebit

default boolean isDebit(InternalAccountOwner owner)

isFromSystem

default boolean isFromSystem()

isFromUser

default boolean isFromUser()

isToSystem

default boolean isToSystem()

isToUser

default boolean isToUser()