org.sistema.cs.doc.persist

Class ItemPerc

java.lang.Object

org.sistema.persist.Persistent

org.sistema.cs.doc.persist.ItemPerc

All Implemented Interfaces:

java.io.Serializable, IItemPerc, org.sistema.persist.IPersistent

public class ItemPerc
extends org.sistema.persist.Persistent
implements IItemPerc

A percentage value of an Item

Since:

28-nov-2005 15:49

Version:

2.0 19-jan-2020 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
ItemPerc()

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getAmount() Calculates the amount.
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() Implementation using a recursive algorithm
boolean	isAddToItemAmount()
boolean	isFixed() Indicates whether the "value" field contains a fixed number, or a rate to perform a calculation.
boolean	isOperateOnBaseAmount()
void	setAddToItemAmount(java.lang.Boolean value) 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 fixed) 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 value) Specifies how the operation is calculated.
void	setOrder(java.lang.Byte order) Sets the order of a percentage as part of an item.
void	setParent(IItem parent) Sets the item to which value this percentage affects.
void	setPercentageType(IPercType child) Sets the type of percentage.
void	setValue(java.math.BigDecimal value) Sets a number representing a fixed number or a rate to perform a calculation.

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.persist.IPersistent

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

Constructor Detail

ItemPerc

public ItemPerc()

Method Detail

getAmount

public java.math.BigDecimal getAmount()

Calculates the amount.

Specified by:

getAmount in interface IItemPerc

Returns:

getAmount

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

Description copied from interface: IItemPerc

Calculates the amount given a base amount and running sum.

Specified by:

getAmount in interface IItemPerc

Returns:

getPercentageType

public IPercType getPercentageType()

Description copied from interface: IItemPerc

Retrieves the type of percentage being represented.

Specified by:

getPercentageType in interface IItemPerc

Returns:

A PercentageType child or null if none has been set.

getId

public java.lang.Integer getId()

Specified by:

getId in interface IItemPerc

Specified by:

getId in interface org.sistema.persist.IPersistent

getOrder

public java.lang.Byte getOrder()

Specified by:

getOrder in interface IItemPerc

Returns:

The order of this percentage inside the item.

getParent

public IItem getParent()

Description copied from interface: IItemPerc

Retrieves the item to which value this percentage affects.

Specified by:

getParent in interface IItemPerc

Returns:

getRate

public java.math.BigDecimal getRate()

Description copied from interface: IItemPerc

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

Specified by:

getRate in interface IItemPerc

Returns:

getRunningSum

public java.math.BigDecimal getRunningSum()

Implementation using a recursive algorithm

Specified by:

getRunningSum in interface IItemPerc

Returns:

isAddToItemAmount

public boolean isAddToItemAmount()

Specified by:

isAddToItemAmount in interface IItemPerc

Returns:

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

isFixed

public boolean isFixed()

Indicates whether the "value" field contains a fixed number, or a rate to perform a calculation.

Specified by:

isFixed in interface IItemPerc

Returns:

isOperateOnBaseAmount

public boolean isOperateOnBaseAmount()

Returns:

setAddToItemAmount

public void setAddToItemAmount(java.lang.Boolean value)

Description copied from interface: IItemPerc

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

Specified by:

setAddToItemAmount in interface IItemPerc

Parameters:

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

setPercentageType

public void setPercentageType(IPercType child)

Description copied from interface: IItemPerc

Sets the type of percentage.

Specified by:

setPercentageType in interface IItemPerc

setFixed

public void setFixed(java.lang.Boolean fixed)

Description copied from interface: IItemPerc

Sets the value of this percentage as a fixed one.

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

Specified by:

setFixed in interface IItemPerc

setId

public void setId(java.lang.Integer id)

Description copied from interface: IItemPerc

Sets the unique identifier.

Specified by:

setId in interface IItemPerc

setOperateOnBaseAmount

public void setOperateOnBaseAmount(java.lang.Boolean value)

Description copied from interface: IItemPerc

Specifies how the operation is calculated.

Specified by:

setOperateOnBaseAmount in interface IItemPerc

Parameters:

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

setOrder

public void setOrder(java.lang.Byte order)

Description copied from interface: IItemPerc

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

Specified by:

setOrder in interface IItemPerc

setParent

public void setParent(IItem parent)

Description copied from interface: IItemPerc

Sets the item to which value this percentage affects.

Specified by:

setParent in interface IItemPerc

setValue

public void setValue(java.math.BigDecimal value)

Description copied from interface: IItemPerc

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

Specified by:

setValue in interface IItemPerc