org.cyclos.entities.banking

Class BasePayment

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.banking.Transaction

org.cyclos.entities.banking.InternalTransaction

org.cyclos.entities.banking.DirectTransaction

org.cyclos.entities.banking.BasePayment

All Implemented Interfaces:

java.lang.Cloneable, HasCurrency, Trans, ProcessableForDataTranslation, EntityWithCustomValues<TransactionCustomField,TransactionCustomFieldPossibleValueCategory,TransactionCustomFieldPossibleValue,TransactionCustomFieldValue>, HasTransactionNumber, IEntity

Direct Known Subclasses:

Payment, RecurringPayment, ScheduledPayment

@Entity
public abstract class BasePayment
extends DirectTransaction

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

Author:

ameyer

Field Summary

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

authorizationStatus, authorizationType, showToReceiver, status, transaction

Constructor Summary

Constructors

Constructor and Description
BasePayment()

Method Summary

Modifier and Type	Method and Description
java.util.List<TransactionAuthorization>	getAuthorizations()
TransactionAuthorizationStatus	getAuthorizationStatus()
TransactionAuthorizationType	getAuthorizationType()
BasicUser	getDestinationUser() If this payment was received by an operator, returns it.
TransactionFeedback	getFeedback()
java.lang.Boolean	getFeedbackExpirationNotified()
java.lang.Boolean	getFeedbackExpirationReminderNotified()
java.lang.Boolean	getFeedbackReminderNotified()
AuthorizationLevel	getNextAuthorizationLevel()
PaymentRequest	getPaymentRequest()
PaymentTransferType	getPaymentType()
java.util.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).
BasicUser	getSourceUser() If this payment was performed 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(java.util.List<TransactionAuthorization> authorizations)
void	setAuthorizationStatus(TransactionAuthorizationStatus authorizationStatus)
void	setAuthorizationType(TransactionAuthorizationType authorizationType)
void	setFeedback(TransactionFeedback feedback)
void	setFeedbackExpirationNotified(java.lang.Boolean feedbackExpirationNotified)
void	setFeedbackExpirationReminderNotified(java.lang.Boolean feedbackExpirationReminderNotified)
void	setFeedbackReminderNotified(java.lang.Boolean feedbackReminderNotified)
void	setNextAuthorizationLevel(AuthorizationLevel nextAuthorizationLevel)
void	setPaymentRequest(PaymentRequest paymentRequest)
void	setPaymentType(PaymentTransferType type)
void	setReceived(boolean received)
void	setReceivedBy(Operator receivedBy)
void	setType(TransferType type)

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

doGetActualAmount, getDestinationAccountLocator, getSourceAccountLocator

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

getToOwner

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

getAccessClient, getActualAmount, getActualBy, getAmount, getBy, getChannel, getCurrency, getCurrencyAmount, getCustomFieldClass, getCustomFieldValueClass, getCustomValues, getDate, getDescription, getFromName, getFromOwner, getFromUser, getLocation, getNature, getNetwork, getPrincipalType, getToName, getToUser, getTransactionNumber, getType, isFromSystem, isFromUser, isToSystem, isToUser, setAccessClient, setAmount, setBy, setBySelf, setChannel, setCustomValues, setDate, setDescription, setFromName, setFromOwner, setPrincipalType, setToName, setToOwner, setTransactionNumber

Methods inherited from class org.cyclos.entities.NetworkedEntity

isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

clone, equals, getId, getId, getIds, getUniqueIds, getUniqueIds, hashCode, isPersistent, isTransient, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.model.IEntity

getId

Constructor Detail

BasePayment

public BasePayment()

Method Detail

getAuthorizations

public java.util.List<TransactionAuthorization> getAuthorizations()

getAuthorizationStatus

public TransactionAuthorizationStatus getAuthorizationStatus()

getAuthorizationType

public TransactionAuthorizationType getAuthorizationType()

getDestinationUser

public BasicUser getDestinationUser()

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

Overrides:

getDestinationUser in class Transaction

See Also:

getDestinationUser()

getFeedback

public TransactionFeedback getFeedback()

getFeedbackExpirationNotified

public java.lang.Boolean getFeedbackExpirationNotified()

getFeedbackExpirationReminderNotified

public java.lang.Boolean getFeedbackExpirationReminderNotified()

getFeedbackReminderNotified

public java.lang.Boolean getFeedbackReminderNotified()

getNextAuthorizationLevel

public AuthorizationLevel getNextAuthorizationLevel()

getPaymentRequest

public PaymentRequest getPaymentRequest()

getPaymentType

public PaymentTransferType getPaymentType()

getProcessDate

public java.util.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.

getSourceUser

public BasicUser getSourceUser()

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

Overrides:

getSourceUser in class Transaction

See Also:

getSourceUser()

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(java.util.List<TransactionAuthorization> authorizations)

setAuthorizationStatus

public void setAuthorizationStatus(TransactionAuthorizationStatus authorizationStatus)

setAuthorizationType

public void setAuthorizationType(TransactionAuthorizationType authorizationType)

setFeedback

public void setFeedback(TransactionFeedback feedback)

setFeedbackExpirationNotified

public void setFeedbackExpirationNotified(java.lang.Boolean feedbackExpirationNotified)

setFeedbackExpirationReminderNotified

public void setFeedbackExpirationReminderNotified(java.lang.Boolean feedbackExpirationReminderNotified)

setFeedbackReminderNotified

public void setFeedbackReminderNotified(java.lang.Boolean feedbackReminderNotified)

setNextAuthorizationLevel

public void setNextAuthorizationLevel(AuthorizationLevel nextAuthorizationLevel)

setPaymentRequest

public void setPaymentRequest(PaymentRequest paymentRequest)

setPaymentType

public void setPaymentType(PaymentTransferType type)

setReceived

public void setReceived(boolean received)

setReceivedBy

public void setReceivedBy(Operator receivedBy)

setType

public void setType(TransferType type)

Overrides:

setType in class Transaction