org.sistema.cs.doc.persist

Class Item

java.lang.Object

org.sistema.persist.Persistent

org.sistema.cs.doc.persist.Item

All Implemented Interfaces:

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

public class Item
extends org.sistema.persist.Persistent
implements IItem

An item of a IDocItemized.

Since:

2006 ( as org.sistema.control.module.doc.Item)

Version:

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

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
Item() Default constructor

Method Summary

Modifier and Type	Method and Description
private void	add(IItemRelation r) Adds an related item.
void	addPercentage(IItemPerc ip)
void	addSource(IItemRelation r) Adds a related item with this item as the source.
void	addTarget(IItemRelation relation) Adds a related item with this item as the target.
java.lang.String	getCode()
IConcept	getConcept()
java.lang.String	getDescriptionSR()
org.sistema.cs.agenda.IAgendaEntry	getEntry()
java.lang.Integer	getId()
java.lang.String	getNotes() Retrieves the notes of the item.
IDocItem	getParent(byte index)
java.util.Collection<IDocItem>	getParents()
IDocItem	getParentType(byte typeId)
IItemPerc	getPercentage(byte typeId) Retrieves an ItemPercentage by type.
java.math.BigDecimal	getPercentageAmount(java.lang.Integer filterId, java.math.BigDecimal docSubtotal, java.math.BigDecimal runningSum)
java.math.BigDecimal	getPercentageAmount(java.lang.Integer filterId, java.math.BigDecimal filterRate, java.math.BigDecimal docSubtotal, java.math.BigDecimal runningSum) Calculates the amount of a percentage type applied to an item at certain rate.
java.util.Collection<IItemPerc>	getPercentages()
java.math.BigDecimal	getPrice()
java.math.BigDecimal	getQuantity() Retrieves the quantity of the item.
java.util.Collection<IDocItem>	getRelatedDocs() Retrieves all documents related to this item.
private java.util.Map<java.lang.Integer,IDocItem>	getRelatedDocsMap()
IItemRelation	getRelatedItem(java.lang.Integer id) Retrieves a related item relationship by its unique identifier.
java.util.Collection<IItemRelation>	getRelatedItems() Retrieves all related items-relationships of this item.
private java.util.Map<java.lang.Integer,IItemRelation>	getRelatedItemsMap()
int	getStatus() Retrieves the status of the item.
java.math.BigDecimal	getSubtotal() Calculates the subtotal based on the price and a quantity of the item.
java.math.BigDecimal	getTotal() Calculates the total of the item defined as its value after applying percentages.
void	remove(IItemRelation relation) Removes a related item.
void	removePercentage(IItemPerc itemPercentage) Removes a percentage from this item.
void	setConcept(IConcept concept) Sets the concept of this item.
void	setId(java.lang.Integer id)
void	setNotes(java.lang.String notes) Sets the notes of this item.
void	setParent(IDoc parent)
void	setPrice(java.math.BigDecimal newPrice) Sets the unit price.
void	setQuantity(java.math.BigDecimal quantity) Sets the quantity of this item.
void	setRelatedDocs(java.util.Collection<IDocItem> docItems) Sets documents related to this item.
void	setStatus(int s) Sets the status of the item.
java.lang.String	toString()

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

Item

public Item()

Default constructor

Method Detail

add

private void add(IItemRelation r)

Adds an related item.

Parameters:

r - An item relationship in which this item is either the source or the target.

addPercentage

public void addPercentage(IItemPerc ip)

Specified by:

addPercentage in interface IItem

addSource

public void addSource(IItemRelation r)

Description copied from interface: IItem

Adds a related item with this item as the source.

Specified by:

addSource in interface IItem

Parameters:

r - A relationship in which this item is the source.

addTarget

public void addTarget(IItemRelation relation)

Description copied from interface: IItem

Adds a related item with this item as the target.

Specified by:

addTarget in interface IItem

Parameters:

relation - A relationship in which this item is the target.

getCode

public java.lang.String getCode()

Specified by:

getCode in interface IItem

Returns:

Code of the item

Since:

v1.5

getConcept

public IConcept getConcept()

Specified by:

getConcept in interface IItem

Returns:

The concept of the item.

getDescriptionSR

public java.lang.String getDescriptionSR()

Specified by:

getDescriptionSR in interface IItem

Returns:

A single-row description of the item.

Since:

v1.4 28-jan-2022

getEntry

public org.sistema.cs.agenda.IAgendaEntry getEntry()

Specified by:

getEntry in interface IItem

Returns:

getId

public java.lang.Integer getId()

Specified by:

getId in interface org.sistema.persist.IPersistent

getRelatedDocs

public java.util.Collection<IDocItem> getRelatedDocs()

Description copied from interface: IItem

Retrieves all documents related to this item.

In other words, all document-item relationships in which this item is the child.

Specified by:

getRelatedDocs in interface IItem

Returns:

Collection of with documents related to this item. An empty collection is returned when there are no documents related.

Since:

v1.7

getRelatedDocsMap

private java.util.Map<java.lang.Integer,IDocItem> getRelatedDocsMap()

getRelatedItem

public IItemRelation getRelatedItem(java.lang.Integer id)

Description copied from interface: IItem

Retrieves a related item relationship by its unique identifier.

Specified by:

getRelatedItem in interface IItem

Parameters:

id - Identifier of the relation wanted.

Returns:

The relation with the given id.

getRelatedItems

public java.util.Collection<IItemRelation> getRelatedItems()

Description copied from interface: IItem

Retrieves all related items-relationships of this item.

Specified by:

getRelatedItems in interface IItem

Returns:

All IItemRelations set on this item.

getRelatedItemsMap

private java.util.Map<java.lang.Integer,IItemRelation> getRelatedItemsMap()

getNotes

public java.lang.String getNotes()

Description copied from interface: IItem

Retrieves the notes of the item.

Specified by:

getNotes in interface IItem

Returns:

Notes of the item.

getParent

public IDocItem getParent(byte index)

Specified by:

getParent in interface IItem

Returns:

The nth relationship of this item with a document

See Also:

IDocItem

getParentType

public IDocItem getParentType(byte typeId)

Specified by:

getParentType in interface IItem

Returns:

The relationship of this item with a document of a given type

See Also:

IDocItem

getParents

public java.util.Collection<IDocItem> getParents()

Specified by:

getParents in interface IItem

Returns:

All relationships of this item with document.

getPercentage

public IItemPerc getPercentage(byte typeId)

Description copied from interface: IItem

Retrieves an ItemPercentage by type.

Specified by:

getPercentage in interface IItem

Parameters:

typeId - Type of the ItemPercentage type being requested.

Returns:

getPercentageAmount

public java.math.BigDecimal getPercentageAmount(java.lang.Integer filterId,
                                                java.math.BigDecimal docSubtotal,
                                                java.math.BigDecimal runningSum)

Specified by:

getPercentageAmount in interface IItem

Returns:

The percentage amount of the item specified.

Since:

v1.6

getPercentageAmount

public java.math.BigDecimal getPercentageAmount(java.lang.Integer filterId,
                                                java.math.BigDecimal filterRate,
                                                java.math.BigDecimal docSubtotal,
                                                java.math.BigDecimal runningSum)

Description copied from interface: IItem

Calculates the amount of a percentage type applied to an item at certain rate.

Specified by:

getPercentageAmount in interface IItem

Returns:

getPercentages

public java.util.Collection<IItemPerc> getPercentages()

Specified by:

getPercentages in interface IItem

Returns:

A collection with registered percentages

getPrice

public java.math.BigDecimal getPrice()

Specified by:

getPrice in interface IItem

Returns:

Unit price of the item.

getQuantity

public java.math.BigDecimal getQuantity()

Description copied from interface: IItem

Retrieves the quantity of the item.

Specified by:

getQuantity in interface IItem

Returns:

Quantity of the item.

getSubtotal

public java.math.BigDecimal getSubtotal()

Description copied from interface: IItem

Calculates the subtotal based on the price and a quantity of the item.

Specified by:

getSubtotal in interface IItem

Returns:

The subtotal of this item.

Since:

v1.6

getStatus

public int getStatus()

Retrieves the status of the item.

Specified by:

getStatus in interface IItem

Returns:

Since:

v1.7

getTotal

public java.math.BigDecimal getTotal()

Description copied from interface: IItem

Calculates the total of the item defined as its value after applying percentages.

Specified by:

getTotal in interface IItem

Returns:

The total amount of the item.

Since:

v1.6

remove

public void remove(IItemRelation relation)

Description copied from interface: IItem

Removes a related item.

Specified by:

remove in interface IItem

Parameters:

relation - Item relationship to be removed.

removePercentage

public void removePercentage(IItemPerc itemPercentage)

Description copied from interface: IItem

Removes a percentage from this item.

Specified by:

removePercentage in interface IItem

Parameters:

itemPercentage - Percentage to be removed.

setConcept

public void setConcept(IConcept concept)

Description copied from interface: IItem

Sets the concept of this item.

Specified by:

setConcept in interface IItem

Parameters:

concept - Concept of this item.

setId

public void setId(java.lang.Integer id)

Specified by:

setId in interface IItem

setNotes

public void setNotes(java.lang.String notes)

Description copied from interface: IItem

Sets the notes of this item.

Specified by:

setNotes in interface IItem

Parameters:

notes - Some notes.

setParent

public void setParent(IDoc parent)

Specified by:

setParent in interface IItem

setPrice

public void setPrice(java.math.BigDecimal newPrice)

Description copied from interface: IItem

Sets the unit price.

Specified by:

setPrice in interface IItem

Parameters:

newPrice - Unit price of this item.

setQuantity

public void setQuantity(java.math.BigDecimal quantity)

Description copied from interface: IItem

Sets the quantity of this item.

Specified by:

setQuantity in interface IItem

Parameters:

quantity - Quantity of this item.

setRelatedDocs

public void setRelatedDocs(java.util.Collection<IDocItem> docItems)

Description copied from interface: IItem

Sets documents related to this item.

Specified by:

setRelatedDocs in interface IItem

Parameters:

docItems - Collection of document-item relationships.

Since:

v1.7

setStatus

public void setStatus(int s)

Sets the status of the item.

Specified by:

setStatus in interface IItem

Parameters:

s - new status as a bit-wise integer.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object