Package org.cyclos.entities.banking

Class BasePayment

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.banking.Transaction

org.cyclos.entities.banking.InternalTransaction

org.cyclos.entities.banking.BasePayment

All Implemented Interfaces:

Cloneable, HasCurrency, HasCurrencyAmount, Trans, HasNetwork, ProcessableForProxying, EntityWithCustomValues<TransactionCustomField,TransactionCustomFieldPossibleValueCategory,TransactionCustomFieldPossibleValue,TransactionCustomFieldValue>, HasTransactionNumber, IEntity, HasAmount

Direct Known Subclasses:

Payment, RecurringPayment, ScheduledPayment

@Entity
public abstract class BasePayment
extends InternalTransaction

Base class for payments and scheduled payment. Payments can be authorized, and can receive payment feedbacks.

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.entities.SimpleEntity

SimpleEntity.EntityLoadNotifier

Field Summary

Fields inherited from class org.cyclos.entities.banking.InternalTransaction

installments

Fields inherited from class org.cyclos.entities.banking.Transaction

authorizationStatus, authorizationType, creationType, expirationDate, nextAuthorizationLevel, receivedBy, showToReceiver, status, transaction

Constructor Summary

Constructors

Constructor	Description
BasePayment()

Method Summary

Modifier and Type	Method	Description
List<TransactionAuthorization>	getAuthorizations()
TransactionAuthorizationStatus	getAuthorizationStatus()	Never returns NA
TransactionAuthorizationType	getAuthorizationType()	Never returns NA
PaymentCreationType	getCreationType()
TransactionFeedback	getFeedback()
Boolean	getFeedbackExpirationNotified()
Boolean	getFeedbackExpirationReminderNotified()
Boolean	getFeedbackReminderNotified()
AuthorizationLevel	getNextAuthorizationLevel()
BaseOidcClient	getOidcClient()
PaymentRequest	getPaymentRequest()
PaymentTransferType	getPaymentType()
Date	getProcessDate()	Returns the date the transaction was actually processed
Operator	getReceivedBy()	Returns the operator who received the payment, it could be in the following two cases: When an operator receives a payment via POS (logged at the moment of receive a payment). When some other member pays directly to an operator, instead of the owner member. Otherwise it returns null.
BasicUser	getReceiver()	If this payment was received by an operator, returns it.
boolean	isAuthorized()	Returns true if the transaction doesn't require authorization or is already authorized.
boolean	isPendingAuthorization()	Returns whether this transaction is in a pending authorization status
boolean	isReceived()
void	setAuthorizations(List<TransactionAuthorization> authorizations)
void	setAuthorizationStatus(TransactionAuthorizationStatus authorizationStatus)
void	setAuthorizationType(TransactionAuthorizationType authorizationType)
void	setCreationType(PaymentCreationType creationType)
void	setFeedback(TransactionFeedback feedback)
void	setFeedbackExpirationNotified(Boolean feedbackExpirationNotified)
void	setFeedbackExpirationReminderNotified(Boolean feedbackExpirationReminderNotified)
void	setFeedbackReminderNotified(Boolean feedbackReminderNotified)
void	setNextAuthorizationLevel(AuthorizationLevel nextAuthorizationLevel)
void	setOidcClient(BaseOidcClient oidcClient)
void	setPaymentRequest(PaymentRequest paymentRequest)
void	setPaymentType(PaymentTransferType type)
void	setReceivedBy(Operator receivedBy)
void	setType(TransferType type)

Methods inherited from class org.cyclos.entities.banking.InternalTransaction

getToOwner, getVoucherTransaction, setVoucherTransaction

Methods inherited from class org.cyclos.entities.banking.Transaction

getAccessClient, getAmount, getBy, getChannel, getCurrency, getCustomFieldClass, getCustomFieldValueClass, getCustomValues, getDate, getDescription, getFrom, getFromBasicUser, getFromName, getLocation, getNature, getNetwork, getPerformer, getPrincipalType, getRelatedName, getTo, getToBasicUser, getToName, getToUser, getTransactionNumber, getType, isPendingNotification, setAccessClient, setAmount, setBy, setChannel, setCustomValues, setDate, setDescription, setFrom, setFromName, setPendingNotification, setPrincipalType, setTo, setToName, setTransactionNumber

Methods inherited from class org.cyclos.entities.BaseEntity

getDataTranslationType, getVersion

Methods inherited from class org.cyclos.entities.NetworkedEntity

isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

equals, getId, hashCode, id, ids, isPersistent, isTransient, register, setId, toShortString, toString, uniqueIds, uniqueIds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.entities.banking.HasCurrency

round, withCurrency

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

getCurrencyAmount

Methods inherited from interface org.cyclos.model.IEntity

getId, matches

Methods inherited from interface org.cyclos.entities.ProcessableForProxying

getProxyClass

Methods inherited from interface org.cyclos.entities.banking.Trans

getActualAmount, getCustomValuesForExport, getFromOwner, getFromOwnerOrType, getFromType, getFromUser, getRelatedAccount, getRelatedOwner, getToOwnerOrType, getToType, getTransactionNumberOrId, isDebit, isFromSystem, isFromUser, isToSystem, isToUser

Constructor Detail

BasePayment

public BasePayment()

Method Detail

getAuthorizations

public List<TransactionAuthorization> getAuthorizations()

getAuthorizationStatus

public TransactionAuthorizationStatus getAuthorizationStatus()

Never returns NA

getAuthorizationType

public TransactionAuthorizationType getAuthorizationType()

Never returns NA

getCreationType

public PaymentCreationType getCreationType()

getFeedback

public TransactionFeedback getFeedback()

getFeedbackExpirationNotified

public Boolean getFeedbackExpirationNotified()

getFeedbackExpirationReminderNotified

public Boolean getFeedbackExpirationReminderNotified()

getFeedbackReminderNotified

public Boolean getFeedbackReminderNotified()

getNextAuthorizationLevel

public AuthorizationLevel getNextAuthorizationLevel()

getOidcClient

public BaseOidcClient getOidcClient()

getPaymentRequest

public PaymentRequest getPaymentRequest()

getPaymentType

public PaymentTransferType getPaymentType()

getProcessDate

public Date getProcessDate()

Description copied from class: Transaction

Returns the date the transaction was actually processed

Specified by:

getProcessDate in class Transaction

Returns:

the processed date only if the transaction doesn't require authorization or was already authorized

getReceivedBy

public Operator getReceivedBy()

Returns the operator who received the payment, it could be in the following two cases:

• When an operator receives a payment via POS (logged at the moment of receive a payment).
• When some other member pays directly to an operator, instead of the owner member.

Otherwise it returns null.

getReceiver

public BasicUser getReceiver()

If this payment was received by an operator, returns it. Otherwise returns the to user, if this payment is to a user

Overrides:

getReceiver in class Transaction

isAuthorized

public boolean isAuthorized()

Returns true if the transaction doesn't require authorization or is already authorized.

isPendingAuthorization

public boolean isPendingAuthorization()

Returns whether this transaction is in a pending authorization status

isReceived

public boolean isReceived()

setAuthorizations

public void setAuthorizations(List<TransactionAuthorization> authorizations)

setAuthorizationStatus

public void setAuthorizationStatus(TransactionAuthorizationStatus authorizationStatus)

setAuthorizationType

public void setAuthorizationType(TransactionAuthorizationType authorizationType)

setCreationType

public void setCreationType(PaymentCreationType creationType)

setFeedback

public void setFeedback(TransactionFeedback feedback)

setFeedbackExpirationNotified

public void setFeedbackExpirationNotified(Boolean feedbackExpirationNotified)

setFeedbackExpirationReminderNotified

public void setFeedbackExpirationReminderNotified(Boolean feedbackExpirationReminderNotified)

setFeedbackReminderNotified

public void setFeedbackReminderNotified(Boolean feedbackReminderNotified)

setNextAuthorizationLevel

public void setNextAuthorizationLevel(AuthorizationLevel nextAuthorizationLevel)

setOidcClient

public void setOidcClient(BaseOidcClient oidcClient)

setPaymentRequest

public void setPaymentRequest(PaymentRequest paymentRequest)

setPaymentType

public void setPaymentType(PaymentTransferType type)

setReceivedBy

public void setReceivedBy(Operator receivedBy)

setType

public void setType(TransferType type)

Overrides:

setType in class Transaction