org.sistema.cs.sale.persist

Class SaleDocument

java.lang.Object

org.sistema.persist.Persistent

org.sistema.cs.doc.persist.Doc

org.sistema.cs.doc.persist.DocItemized

org.sistema.cs.sale.persist.SaleDocument

All Implemented Interfaces:

java.io.Serializable, IDoc, IDocItemized, IDocValued, ISaleDoc, org.sistema.persist.IPersistent

Direct Known Subclasses:

COrder

public class SaleDocument
extends DocItemized
implements ISaleDoc

A sales document.

Since:

20-aug-2016

Version:

0.4 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
SaleDocument()

Method Summary

Modifier and Type	Method and Description
org.sistema.cs.agenda.IAgendaEntry	getAgent()
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)
ISaleTerm	getSaleTerm()
java.math.BigDecimal	getSubtotal() Calculates the subtotal of an invoice based an all it's items value.
java.math.BigDecimal	getTotal() Calculates the total of the document by adding the value all its items including percentages.
void	setAgent(org.sistema.cs.agenda.IAgendaEntry agent) Sets the sale agent who took care of the document.
void	setSaleTerm(ISaleTerm term) Sets the sales terms of the document.

Methods inherited from class org.sistema.cs.doc.persist.DocItemized

add, add, clearItems, getAmount, getDocItems, setDocItems, toString

Methods inherited from class org.sistema.cs.doc.persist.Doc

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

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.cs.doc.persist.IDocItemized

add, add, clearItems, getDocItems, setDocItems

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

getAmount, getCurrency, setCurrency

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

Constructor Detail

SaleDocument

public SaleDocument()

Method Detail

getAgent

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

Specified by:

getAgent in interface ISaleDoc

Returns:

The sales agent.

getPercentageAmount

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

Specified by:

getPercentageAmount in interface IDocValued

Returns:

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

getPercentageAmount

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

Specified by:

getPercentageAmount in interface IDocValued

Returns:

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

getPercentageAmount

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

Specified by:

getPercentageAmount in interface IDocValued

Returns:

The percentage amount of the item specified.

getSaleTerm

public ISaleTerm getSaleTerm()

Specified by:

getSaleTerm in interface ISaleDoc

Returns:

The sale terms of the document.

getSubtotal

public java.math.BigDecimal getSubtotal()

Calculates the subtotal of an invoice based an all it's items value.

Specified by:

getSubtotal in interface IDocValued

Returns:

Subtotal of the document (before percentages).

getTotal

public java.math.BigDecimal getTotal()

Description copied from interface: IDocValued

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

Specified by:

getTotal in interface IDocValued

Returns:

Total amount of the document.

setAgent

public void setAgent(org.sistema.cs.agenda.IAgendaEntry agent)

Description copied from interface: ISaleDoc

Sets the sale agent who took care of the document.

Specified by:

setAgent in interface ISaleDoc

setSaleTerm

public void setSaleTerm(ISaleTerm term)

Description copied from interface: ISaleDoc

Sets the sales terms of the document.

Specified by:

setSaleTerm in interface ISaleDoc

Parameters:

term - Sales terms of the document.