org.sistema.cs.doc.persist

Class Payment

java.lang.Object

org.sistema.persist.Persistent

org.sistema.cs.doc.persist.DocRelation

org.sistema.cs.doc.persist.Payment

All Implemented Interfaces:

java.io.Serializable, IDocRelation, IPayment, org.sistema.persist.IPersistent

public class Payment
extends DocRelation
implements IPayment

A payment.

The source document pays the target document an amount using an exchange rate.

Since:

21-aug-2010

Version:

1.5 19-apr-2019 Juan Díaz

Author:

Juan Díaz

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sistema.persist.Persistent

attributes, STATE_DELETABLE, STATE_DELETED, STATE_NEW

Constructor Summary

Constructors

Constructor and Description
Payment()

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getAmount()
java.math.BigDecimal	getAmountTarget()
java.math.BigDecimal	getExchangeRate()
java.lang.String	getForm() Retrieves the form used to perform the payment.
java.lang.String	getNote() Retrieves notes regarding the payment.
java.lang.String	getReference() Retrieves a related reference.
void	setAmount(java.math.BigDecimal amount) Set the amount payed with the source document to the target document.
void	setExchangeRate(java.math.BigDecimal rate)
void	setForm(java.lang.String f) Sets the form how the payment was performed.
void	setNote(java.lang.String n) Sets a new note on the payment.
void	setReference(java.lang.String r) Sets a reference related to the payment.

Methods inherited from class org.sistema.cs.doc.persist.DocRelation

getId, getSource, getTarget, getType, setSource, setTarget, setType

Methods inherited from class org.sistema.persist.Persistent

addAttribute, addAttribute, equals, getAttribute, getAttributeMaximumLength, getAttributeMinimumLength, getAttributeValue, getField, getFieldFlagValue, getFieldNames, getFields, getFieldsUnsavedElements, getFieldValue, getPrimaryKey, getValue, hasUnsavedElements, isAttributeEditable, isAttributeRequired, isAttributeVisible, isAttributeVisible, isDeletable, isDeleted, isEditable, isFieldModified, isFieldState, isModified, isModifiedBase, isNew, setAttributeValue, setDeletable, setDeleted, setFieldFlag, setFieldState, setFieldValue, setNew

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.sistema.cs.doc.persist.IDocRelation

getSource, getTarget, getType, setSource, setTarget, setType

Methods inherited from interface org.sistema.persist.IPersistent

getFieldNames, getFields, getFieldValue, getId, isAttributeEditable, isAttributeVisible, isDeleted, isFieldState, isModified, isModifiedBase, isNew, setFieldState, setFieldValue

Constructor Detail

Payment

public Payment()

Method Detail

getAmount

public java.math.BigDecimal getAmount()

Specified by:

getAmount in interface IPayment

Returns:

Amount payed from source document to target document, in the currency of the source document.

getAmountTarget

public java.math.BigDecimal getAmountTarget()

Specified by:

getAmountTarget in interface IPayment

Returns:

Amount payed from source document to target document, in the currency of the target document.

getExchangeRate

public java.math.BigDecimal getExchangeRate()

Specified by:

getExchangeRate in interface IPayment

Returns:

Exchange rate applied to the payment when source and target documents are issued on different currencies.

getForm

public java.lang.String getForm()

Description copied from interface: IPayment

Retrieves the form used to perform the payment.

Specified by:

getForm in interface IPayment

Returns:

payment form such as cash, credit card, wire transfer, etc.

getNote

public java.lang.String getNote()

Description copied from interface: IPayment

Retrieves notes regarding the payment.

Specified by:

getNote in interface IPayment

Returns:

getReference

public java.lang.String getReference()

Description copied from interface: IPayment

Retrieves a related reference.

Specified by:

getReference in interface IPayment

Returns:

the related reference

setAmount

public void setAmount(java.math.BigDecimal amount)

Description copied from interface: IPayment

Set the amount payed with the source document to the target document.

Specified by:

setAmount in interface IPayment

setExchangeRate

public void setExchangeRate(java.math.BigDecimal rate)

Specified by:

setExchangeRate in interface IPayment

Parameters:

rate - Exchange rate used for the payment when source and target documents are issued on different currencIES.

setForm

public void setForm(java.lang.String f)

Description copied from interface: IPayment

Sets the form how the payment was performed.

Specified by:

setForm in interface IPayment

Parameters:

f - form such as cash, credit card, wire transfer, etc.

setNote

public void setNote(java.lang.String n)

Description copied from interface: IPayment

Sets a new note on the payment.

Specified by:

setNote in interface IPayment

Parameters:

n - note to be set

setReference

public void setReference(java.lang.String r)

Description copied from interface: IPayment

Sets a reference related to the payment.

Specified by:

setReference in interface IPayment

Parameters:

r - related reference