org.sistema.cs.doc.persist

Interface IItem

All Superinterfaces:

org.sistema.persist.IPersistent

All Known Implementing Classes:

Item

public interface IItem
extends org.sistema.persist.IPersistent

An item of a IDocItemized document.

Since:

17-nov-2005 as ItemInterface

Version:

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

Author:

Juan Díaz

Method Summary

Modifier and Type	Method and Description
void	addPercentage(IItemPerc itemPercentage)
void	addSource(IItemRelation relation) 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.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.
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.
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 price) 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.

Methods inherited from interface org.sistema.persist.IPersistent

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

Method Detail

addSource

void addSource(IItemRelation relation)

Adds a related item with this item as the source.

Parameters:

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

Since:

v1.3

addTarget

void addTarget(IItemRelation relation)

Adds a related item with this item as the target.

Parameters:

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

Since:

v1.3

addPercentage

void addPercentage(IItemPerc itemPercentage)

Parameters:

itemPercentage -

getCode

java.lang.String getCode()

Returns:

Code of the item

Since:

v1.1 15-feb-2012

getConcept

IConcept getConcept()

Returns:

The concept of the item.

getDescriptionSR

java.lang.String getDescriptionSR()

Returns:

A single-row description of the item.

Since:

v1.1 28-jan-2012

getEntry

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

Returns:

getNotes

java.lang.String getNotes()

Retrieves the notes of the item.

Returns:

Notes of the item.

getParent

IDocItem getParent(byte index)

Parameters:

index -

Returns:

The nth relationship of this item with a document

See Also:

IDocItem

getParentType

IDocItem getParentType(byte typeId)

Parameters:

typeId -

Returns:

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

See Also:

IDocItem

getParents

java.util.Collection<IDocItem> getParents()

Returns:

All relationships of this item with document.

getPercentage

IItemPerc getPercentage(byte typeId)

Retrieves an ItemPercentage by type.

Parameters:

typeId - Type of the ItemPercentage type being requested.

Returns:

Since:

04-nov-2011

getPercentageAmount

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.

Parameters:

filterId -

filterRate -

docSubtotal -

runningSum -

Returns:

Since:

v1.2

getPercentageAmount

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

Parameters:

filterId -

docSubtotal -

runningSum -

Returns:

The percentage amount of the item specified.

Since:

v1.2

getPercentages

java.util.Collection<IItemPerc> getPercentages()

Returns:

A collection with registered percentages

getPrice

java.math.BigDecimal getPrice()

Returns:

Unit price of the item.

getQuantity

java.math.BigDecimal getQuantity()

Retrieves the quantity of the item.

Returns:

Quantity of the item.

getRelatedItem

IItemRelation getRelatedItem(java.lang.Integer id)

Retrieves a related item relationship by its unique identifier.

Parameters:

id - Identifier of the relation wanted.

Returns:

The relation with the given id.

Since:

v1.3

getRelatedDocs

java.util.Collection<IDocItem> getRelatedDocs()

Retrieves all documents related to this item.

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

Returns:

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

Since:

v1.3

getRelatedItems

java.util.Collection<IItemRelation> getRelatedItems()

Retrieves all related items-relationships of this item.

Returns:

All IItemRelations set on this item.

Since:

v1.3

getSubtotal

java.math.BigDecimal getSubtotal()

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

Returns:

The subtotal of this item.

Since:

v1.2

getStatus

int getStatus()

Retrieves the status of the item.

Returns:

an integer containing status bits.

getTotal

java.math.BigDecimal getTotal()

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

Returns:

The total amount of the item.

Since:

v1.2

remove

void remove(IItemRelation relation)

Removes a related item.

Parameters:

relation - Item relationship to be removed.

Since:

v1.3

removePercentage

void removePercentage(IItemPerc itemPercentage)

Removes a percentage from this item.

Parameters:

itemPercentage - Percentage to be removed.

setConcept

void setConcept(IConcept concept)

Sets the concept of this item.

Parameters:

concept - Concept of this item.

setId

void setId(java.lang.Integer id)

setNotes

void setNotes(java.lang.String notes)

Sets the notes of this item.

Parameters:

notes - Some notes.

setParent

void setParent(IDoc parent)

Parameters:

parent -

setPrice

void setPrice(java.math.BigDecimal price)

Sets the unit price.

Parameters:

price - Unit price of this item.

setQuantity

void setQuantity(java.math.BigDecimal quantity)

Sets the quantity of this item.

Parameters:

quantity - Quantity of this item.

setRelatedDocs

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

Sets documents related to this item.

Parameters:

docItems - Collection of document-item relationships.

Since:

v1.3

setStatus

void setStatus(int s)

Sets the status of the item.

Parameters:

s -