org.sistema.cs.doc.persist

Interface IDocValued

All Superinterfaces:

IDoc

All Known Subinterfaces:

ICOrder, ISaleDoc

All Known Implementing Classes:

COrder, DocValued, SaleDocument

public interface IDocValued
extends IDoc

A document with an accepted value in a given currency.

Since:

15-nov-2011 (as IDocumentValue)

Version:

1.3 08-nov-2020 Juan Díaz (Yancuicalco, Tepoztlán)

Author:

Juan Díaz

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getAmount()
org.sistema.jcs.atlas.ICurrency	getCurrency()
java.math.BigDecimal	getPercentageAmount(java.lang.Integer percentageTypeFilter)
java.math.BigDecimal	getPercentageAmount(java.lang.Integer percentageTypeFilter, java.math.BigDecimal rate)
java.math.BigDecimal	getPercentageAmount(java.lang.Integer itemNumber, java.lang.Integer percentageTypeFilter)
java.math.BigDecimal	getSubtotal()
java.math.BigDecimal	getTotal() Calculates the total of the document by adding the value all its items including percentages.
void	setCurrency(org.sistema.jcs.atlas.ICurrency currency) Sets the currency in which the amount of the document is expressed.

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

add, addSource, addTarget, getDate, getEntry, getId, getNumber, getRelatedDocs, getStatus, getTime, getType, isStatus, setDate, setEntry, setId, setNumber, setStatus, setTime, setType

Method Detail

getAmount

java.math.BigDecimal getAmount()

Returns:

Since:

v1.5

getCurrency

org.sistema.jcs.atlas.ICurrency getCurrency()

Returns:

Currency in which the amount of the document is expressed.

getPercentageAmount

java.math.BigDecimal getPercentageAmount(java.lang.Integer percentageTypeFilter)

Parameters:

percentageTypeFilter -

Returns:

The amount of an item affected by a given percentage type.

getPercentageAmount

java.math.BigDecimal getPercentageAmount(java.lang.Integer percentageTypeFilter,
                                         java.math.BigDecimal rate)

Parameters:

percentageTypeFilter -

rate -

Returns:

The amount of an item affected by a given percentage type.

Since:

v1.4

getPercentageAmount

java.math.BigDecimal getPercentageAmount(java.lang.Integer itemNumber,
                                         java.lang.Integer percentageTypeFilter)

Parameters:

itemNumber -

percentageTypeFilter -

Returns:

The percentage amount of the item specified.

Since:

v1.4

getSubtotal

java.math.BigDecimal getSubtotal()

Returns:

Subtotal of the document (before percentages).

Since:

v1.4

getTotal

java.math.BigDecimal getTotal()

Calculates the total of the document by adding the value all its items including percentages.

Returns:

Total amount of the document.

setCurrency

void setCurrency(org.sistema.jcs.atlas.ICurrency currency)

Sets the currency in which the amount of the document is expressed.

Parameters:

currency -