org.sistema.cs.doc.persist

Interface IItemPerc

All Superinterfaces:

org.sistema.persist.IPersistent

All Known Implementing Classes:

ItemPerc

public interface IItemPerc
extends org.sistema.persist.IPersistent

Operations on a percentage of an item.

Since:

21-aug-2016

Version:

0.3 19-jan-2020 Juan Díaz

Author:

Juan Díaz

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getAmount() Calculates the amount based on the fixed and base amount attributes..
java.math.BigDecimal	getAmount(java.math.BigDecimal baseAmount, java.math.BigDecimal runningSum) Calculates the amount given a base amount and running sum.
java.lang.Integer	getId()
java.lang.Byte	getOrder()
IItem	getParent() Retrieves the item to which value this percentage affects.
IPercType	getPercentageType() Retrieves the type of percentage being represented.
java.math.BigDecimal	getRate() When isFixed is true, the fixed value, the rate otherwise.
java.math.BigDecimal	getRunningSum() Calculates the running sum before the given ItemPercentage instance.
boolean	isAddToItemAmount()
boolean	isFixed() Indicates if the "value" is a fixed number, or a rate to perform a calculation.
void	setAddToItemAmount(java.lang.Boolean a) Specifies whether the result of the calculation (item amount * percentage value) should be added to the amount of the item or not.
void	setFixed(java.lang.Boolean f) Sets the value of this percentage as a fixed one.
void	setId(java.lang.Integer id) Sets the unique identifier.
void	setOperateOnBaseAmount(java.lang.Boolean o) Specifies how the operation is calculated.
void	setOrder(java.lang.Byte o) Sets the order of a percentage as part of an item.
void	setParent(IItem i) Sets the item to which value this percentage affects.
void	setPercentageType(IPercType t) Sets the type of percentage.
void	setValue(java.math.BigDecimal v) Sets a number representing a fixed number or a rate to perform a calculation.

Methods inherited from interface org.sistema.persist.IPersistent

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

Method Detail

getAmount

java.math.BigDecimal getAmount()

Calculates the amount based on the fixed and base amount attributes..

Returns:

getAmount

java.math.BigDecimal getAmount(java.math.BigDecimal baseAmount,
                               java.math.BigDecimal runningSum)

Calculates the amount given a base amount and running sum.

Parameters:

baseAmount -

runningSum -

Returns:

getId

java.lang.Integer getId()

Specified by:

getId in interface org.sistema.persist.IPersistent

Returns:

getOrder

java.lang.Byte getOrder()

Returns:

The order of this percentage inside the item.

getParent

IItem getParent()

Retrieves the item to which value this percentage affects.

Returns:

getPercentageType

IPercType getPercentageType()

Retrieves the type of percentage being represented.

Returns:

A PercentageType child or null if none has been set.

getRate

java.math.BigDecimal getRate()

When isFixed is true, the fixed value, the rate otherwise.

Returns:

getRunningSum

java.math.BigDecimal getRunningSum()

Calculates the running sum before the given ItemPercentage instance.

Returns:

isAddToItemAmount

boolean isAddToItemAmount()

Returns:

true if the value of this percentage should be added to the amount of the item.

isFixed

boolean isFixed()

Indicates if the "value" is a fixed number, or a rate to perform a calculation.

Returns:

setAddToItemAmount

void setAddToItemAmount(java.lang.Boolean a)

Specifies whether the result of the calculation (item amount * percentage value) should be added to the amount of the item or not.

Parameters:

a - true adds the result of the calculation to the amount of the item , false will not add it.

setFixed

void setFixed(java.lang.Boolean f)

Sets the value of this percentage as a fixed one.

The value of a fixed percentage is based on its amount and rate.

Parameters:

f -

setId

void setId(java.lang.Integer id)

Sets the unique identifier.

Parameters:

id -

setOperateOnBaseAmount

void setOperateOnBaseAmount(java.lang.Boolean o)

Specifies how the operation is calculated.

Parameters:

o - true takes the item base amount, false takes the running sum.

setOrder

void setOrder(java.lang.Byte o)

Sets the order of a percentage as part of an item.

Parameters:

o -

setParent

void setParent(IItem i)

Sets the item to which value this percentage affects.

Parameters:

i -

Since:

v0.2

setPercentageType

void setPercentageType(IPercType t)

Sets the type of percentage.

Parameters:

t -

Since:

v0.2

setValue

void setValue(java.math.BigDecimal v)

Sets a number representing a fixed number or a rate to perform a calculation.

Parameters:

v -