org.sistema.cs.doc.persist

Interface IPayment

All Superinterfaces:

IDocRelation, org.sistema.persist.IPersistent

All Known Implementing Classes:

Payment

public interface IPayment
extends IDocRelation, org.sistema.persist.IPersistent

Operations of a payment.

Since:

27-mar-2017

Version:

0.1 19-apr-2019 Juan Díaz

Author:

Juan Diaz

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

Method Detail

getAmount

java.math.BigDecimal getAmount()

Returns:

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

getAmountTarget

java.math.BigDecimal getAmountTarget()

Returns:

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

getExchangeRate

java.math.BigDecimal getExchangeRate()

Returns:

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

getForm

java.lang.String getForm()

Retrieves the form used to perform the payment.

Returns:

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

getNote

java.lang.String getNote()

Retrieves notes regarding the payment.

Returns:

Since:

v0.1

getReference

java.lang.String getReference()

Retrieves a related reference.

Returns:

the related reference

setAmount

void setAmount(java.math.BigDecimal amount)

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

Parameters:

amount -

setExchangeRate

void setExchangeRate(java.math.BigDecimal rate)

Parameters:

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

setForm

void setForm(java.lang.String f)

Sets the form how the payment was performed.

Parameters:

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

Since:

v0.1

setNote

void setNote(java.lang.String n)

Sets a new note on the payment.

Parameters:

n - note to be set

setReference

void setReference(java.lang.String r)

Sets a reference related to the payment.

Parameters:

r - related reference

Since:

v0.1