Package org.cyclos.entities.banking

Class PaymentRequest

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

All Implemented Interfaces:

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

@Entity
public class PaymentRequest
extends InternalTransaction
implements HasTransactionStatus<PaymentRequestStatus>, HasExpirationDate

A payment request is sent from a user or system to another user or system. Once accepted, a Transaction (either a Payment, ScheduledPayment or RecurringPayment) is generated, and the payment is processed.

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
PaymentRequest()

Method Summary

Modifier and Type	Method	Description
String	getComments()
Date	getExpirationDate()
String	getExpirationDateComments()
Location	getLocation()
TransactionNature	getNature()
TimeInterval	getOccurrenceInterval()
Date	getProcessDate()	Returns the date the transaction was actually processed
SchedulingType	getScheduling()
Integer	getSchedulingCount()
String	getSmsCode()	Returns the SMS code.
PaymentRequestStatus	getStatus()
BasePayment	getTransaction()
boolean	isFirstSchedulingIsImmediate()
void	setComments(String comments)
void	setExpirationDate(Date expirationDate)
void	setExpirationDateComments(String expirationDateComments)
void	setFirstSchedulingIsImmediate(Boolean firstSchedulingIsImmediate)
void	setOccurrenceInterval(TimeInterval occurrenceInterval)
void	setProcessDate(Date processDate)
void	setScheduling(SchedulingType scheduling)
void	setSchedulingCount(Integer schedulingCount)
void	setSmsCode(String smsCode)
void	setStatus(PaymentRequestStatus status)
void	setTransaction(BasePayment transaction)

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, getNetwork, getPerformer, getPrincipalType, getReceiver, getRelatedName, getTo, getToBasicUser, getToName, getToUser, getTransactionNumber, getType, isPendingNotification, setAccessClient, setAmount, setBy, setChannel, setCustomValues, setDate, setDescription, setFrom, setFromName, setPendingNotification, setPrincipalType, setTo, setToName, setTransactionNumber, setType

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

PaymentRequest

public PaymentRequest()

Method Detail

getComments

public String getComments()

getExpirationDate

public Date getExpirationDate()

Specified by:

getExpirationDate in interface HasExpirationDate

getExpirationDateComments

public String getExpirationDateComments()

getLocation

public Location getLocation()

Specified by:

getLocation in class Transaction

getNature

public TransactionNature getNature()

Specified by:

getNature in class Transaction

getOccurrenceInterval

public TimeInterval getOccurrenceInterval()

getProcessDate

public Date getProcessDate()

Description copied from class: Transaction

Returns the date the transaction was actually processed

Specified by:

getProcessDate in class Transaction

getScheduling

public SchedulingType getScheduling()

getSchedulingCount

public Integer getSchedulingCount()

getSmsCode

public String getSmsCode()

Returns the SMS code. This code is used to identify a payment request sent by SMS. With this code a user can deny or accept (by SMS) the payment request.

getStatus

public PaymentRequestStatus getStatus()

Specified by:

getStatus in interface HasTransactionStatus<PaymentRequestStatus>

getTransaction

public BasePayment getTransaction()

isFirstSchedulingIsImmediate

public boolean isFirstSchedulingIsImmediate()

setComments

public void setComments(String comments)

setExpirationDate

public void setExpirationDate(Date expirationDate)

Specified by:

setExpirationDate in interface HasExpirationDate

setExpirationDateComments

public void setExpirationDateComments(String expirationDateComments)

setFirstSchedulingIsImmediate

public void setFirstSchedulingIsImmediate(Boolean firstSchedulingIsImmediate)

setOccurrenceInterval

public void setOccurrenceInterval(TimeInterval occurrenceInterval)

setProcessDate

public void setProcessDate(Date processDate)

setScheduling

public void setScheduling(SchedulingType scheduling)

setSchedulingCount

public void setSchedulingCount(Integer schedulingCount)

setSmsCode

public void setSmsCode(String smsCode)

setStatus

public void setStatus(PaymentRequestStatus status)

Specified by:

setStatus in interface HasTransactionStatus<PaymentRequestStatus>

setTransaction

public void setTransaction(BasePayment transaction)