org.turro.financials.entity.DocumentLine Class Reference

Inheritance diagram for org.turro.financials.entity.DocumentLine:

Collaboration diagram for org.turro.financials.entity.DocumentLine:

Public Member Functions
String	getConcept ()
void	setConcept (String concept)
ContractPreference	getContractPreference ()
void	setContractPreference (ContractPreference contractPreference)
double	getDiscountMoney ()
void	setDiscountMoney (double discountMoney)
double	getDiscountPerCent ()
void	setDiscountPerCent (double discountPerCent)
Document	getDocument ()
void	setDocument (Document document)
long	getId ()
void	setId (long id)
int	getLineOrder ()
void	setLineOrder (int lineOrder)
LineType	getLineType ()
void	setLineType (LineType lineType)
double	getPrice ()
void	setPrice (double price)
Product	getProduct ()
void	setProduct (Product product)
ProductByContractor	getProductByContractor ()
void	setProductByContractor (ProductByContractor productByContractor)
double	getQuantity ()
void	setQuantity (double quantity)
double	getRetention ()
void	setRetention (double retention)
Contract	getStore ()
void	setStore (Contract store)
double	getTax ()
void	setTax (double tax)
double	getEquivalenceSurcharge ()
void	setEquivalenceSurcharge (double equivalenceSurcharge)
boolean	isEmpty ()
void	clearLine ()
String	getDescription ()
double	getSubtotal ()
double	getRetained ()
double	getDiscount ()
Double	getTaxable ()
Double	getFullTaxValue ()
Double	getTaxValue ()
Double	getRealTaxValue ()
Double	getEquivalenceSurchargeValue ()
Double	getAmount ()
Double	getToDeclare ()
Double	getFullTax ()
void	assignValuesFrom (DocumentLine documentLine)

Detailed Description

Author

Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 29 of file DocumentLine.java.

Member Function Documentation

assignValuesFrom()

void org.turro.financials.entity.DocumentLine.assignValuesFrom

(

DocumentLine

documentLine

)

Definition at line 304 of file DocumentLine.java.

                                                          {
    setDocument(documentLine.getDocument());
    setStore(documentLine.getStore());
    setProduct(documentLine.getProduct());
    setProductByContractor(documentLine.getProductByContractor());
    setConcept(documentLine.getConcept());
    setQuantity(documentLine.getQuantity());
    setPrice(documentLine.getPrice());
    setTax(documentLine.getTax());
    setEquivalenceSurcharge(documentLine.getEquivalenceSurcharge());
    setRetention(documentLine.getRetention());
    setDiscountPerCent(documentLine.getDiscountPerCent());
    setDiscountMoney(documentLine.getDiscountMoney());
    setLineType(documentLine.getLineType());
    setContractPreference(documentLine.getContractPreference());
  }

Here is the call graph for this function:

clearLine()

void org.turro.financials.entity.DocumentLine.clearLine

(

)

Definition at line 213 of file DocumentLine.java.

                          {
    setProduct(null);
    setProductByContractor(null);
    setConcept(null);
    setQuantity(0);
    setPrice(0);
    setTax(0);
    setDiscountPerCent(0);
    setDiscountMoney(0);
  }

Here is the call graph for this function:

getAmount()

Double org.turro.financials.entity.DocumentLine.getAmount

(

)

Definition at line 284 of file DocumentLine.java.

                            {
    if(document.getContract().getOperatingModifier().isSumTax(this)) {
      return new Round((getTaxable() * (1.0 + getFullTax() / 100.0)) - getRetained()).decimals(document.getCurrency().getDefaultFractionDigits()).value();
    } else {
      return getTaxable() - getRetained();
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getConcept()

String org.turro.financials.entity.DocumentLine.getConcept

(

)

Definition at line 66 of file DocumentLine.java.

                             {
    return concept;
  }

Here is the caller graph for this function:

getContractPreference()

ContractPreference org.turro.financials.entity.DocumentLine.getContractPreference

(

)

Definition at line 79 of file DocumentLine.java.

                                                    {
    return contractPreference;
  }

Here is the caller graph for this function:

getDescription()

String org.turro.financials.entity.DocumentLine.getDescription

(

)

Definition at line 224 of file DocumentLine.java.

                                 {
    if(product != null) {
      return product.getDescription();
    }
    if(productByContractor != null && productByContractor.getProduct() != null) {
      return productByContractor.getProduct().getDescription();
    }
    return null;
  }

getDiscount()

double org.turro.financials.entity.DocumentLine.getDiscount

(

)

Definition at line 243 of file DocumentLine.java.

                              {
    return new Round(((getSubtotal() - discountMoney) * (discountPerCent / 100.0)) + discountMoney).decimals(document.getCurrency().getDefaultFractionDigits()).value();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getDiscountMoney()

double org.turro.financials.entity.DocumentLine.getDiscountMoney

(

)

Definition at line 87 of file DocumentLine.java.

                                   {
    return discountMoney;
  }

Here is the caller graph for this function:

getDiscountPerCent()

double org.turro.financials.entity.DocumentLine.getDiscountPerCent

(

)

Definition at line 95 of file DocumentLine.java.

                                     {
    return discountPerCent;
  }

Here is the caller graph for this function:

getDocument()

Document org.turro.financials.entity.DocumentLine.getDocument

(

)

Definition at line 103 of file DocumentLine.java.

                                {
    return document;
  }

Here is the caller graph for this function:

getEquivalenceSurcharge()

double org.turro.financials.entity.DocumentLine.getEquivalenceSurcharge

(

)

Definition at line 197 of file DocumentLine.java.

                                          {
    return equivalenceSurcharge;
  }

Here is the caller graph for this function:

getEquivalenceSurchargeValue()

Double org.turro.financials.entity.DocumentLine.getEquivalenceSurchargeValue

(

)

Definition at line 277 of file DocumentLine.java.

                                               {
    if(equivalenceSurcharge > 0) {
      return getFullTaxValue() - getRealTaxValue();
    }
    return 0.0;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getFullTax()

Double org.turro.financials.entity.DocumentLine.getFullTax

(

)

Definition at line 300 of file DocumentLine.java.

                             {
    return tax + equivalenceSurcharge;
  }

Here is the caller graph for this function:

getFullTaxValue()

Double org.turro.financials.entity.DocumentLine.getFullTaxValue

(

)

Definition at line 251 of file DocumentLine.java.

                                  {
    return (getAmount() + getRetained()) - getTaxable();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getId()

long org.turro.financials.entity.DocumentLine.getId

(

)

Definition at line 111 of file DocumentLine.java.

                      {
    return id;
  }

Here is the caller graph for this function:

getLineOrder()

int org.turro.financials.entity.DocumentLine.getLineOrder

(

)

Definition at line 119 of file DocumentLine.java.

                            {
    return lineOrder;
  }

Here is the caller graph for this function:

getLineType()

LineType org.turro.financials.entity.DocumentLine.getLineType

(

)

Definition at line 127 of file DocumentLine.java.

                                {
    if(lineType != null) {
      lineType.setContractPreference(contractPreference);
    }
    return lineType;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getPrice()

double org.turro.financials.entity.DocumentLine.getPrice

(

)

Definition at line 141 of file DocumentLine.java.

                           {
    return price;
  }

Here is the caller graph for this function:

getProduct()

Product org.turro.financials.entity.DocumentLine.getProduct

(

)

Definition at line 149 of file DocumentLine.java.

                              {
    return product;
  }

Here is the caller graph for this function:

getProductByContractor()

ProductByContractor org.turro.financials.entity.DocumentLine.getProductByContractor

(

)

Definition at line 157 of file DocumentLine.java.

                                                      {
    return productByContractor;
  }

Here is the caller graph for this function:

getQuantity()

double org.turro.financials.entity.DocumentLine.getQuantity

(

)

Definition at line 165 of file DocumentLine.java.

                              {
    return quantity;
  }

Here is the caller graph for this function:

getRealTaxValue()

Double org.turro.financials.entity.DocumentLine.getRealTaxValue

(

)

Definition at line 266 of file DocumentLine.java.

                                  {
    if(tax != 0) {
      if(equivalenceSurcharge != 0) {
        return new Round(getFullTaxValue() * tax / getFullTax()).decimals(document.getCurrency().getDefaultFractionDigits()).value();
      } else {
        return getTaxValue();
      }
    }
    return 0.0;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getRetained()

double org.turro.financials.entity.DocumentLine.getRetained

(

)

Definition at line 239 of file DocumentLine.java.

                              {
    return new Round((getSubtotal() - getDiscount()) * (retention / 100.0)).decimals(document.getCurrency().getDefaultFractionDigits()).value();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getRetention()

double org.turro.financials.entity.DocumentLine.getRetention

(

)

Definition at line 173 of file DocumentLine.java.

                               {
    return retention;
  }

Here is the caller graph for this function:

getStore()

Contract org.turro.financials.entity.DocumentLine.getStore

(

)

Definition at line 181 of file DocumentLine.java.

                             {
    return store;
  }

Here is the caller graph for this function:

getSubtotal()

double org.turro.financials.entity.DocumentLine.getSubtotal

(

)

Definition at line 234 of file DocumentLine.java.

                              {
    int fractions = document.getCurrency() == null ? 2 : document.getCurrency().getDefaultFractionDigits();
    return new Round(quantity == 0 ? price : price * quantity).decimals(fractions).value();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getTax()

double org.turro.financials.entity.DocumentLine.getTax

(

)

Definition at line 189 of file DocumentLine.java.

                         {
    return tax;
  }

Here is the caller graph for this function:

getTaxable()

Double org.turro.financials.entity.DocumentLine.getTaxable

(

)

Definition at line 247 of file DocumentLine.java.

                             {
    return new Round(getSubtotal() - getDiscount()).decimals(document.getCurrency().getDefaultFractionDigits()).value();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getTaxValue()

Double org.turro.financials.entity.DocumentLine.getTaxValue

(

)

Definition at line 255 of file DocumentLine.java.

                              {
    if(document.getContract().getOperatingModifier().isSumTax(this)) {
      return getFullTaxValue();
    } else {
      Double taxable = getTaxable();
      return new Round((taxable * (1.0 + getFullTax() / 100.0)) - getRetained())
              .decimals(document.getCurrency().getDefaultFractionDigits())
              .value() - taxable;
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getToDeclare()

Double org.turro.financials.entity.DocumentLine.getToDeclare

(

)

Definition at line 292 of file DocumentLine.java.

                               {
    if(document.getContract().getOperatingModifier().isSumTax(this)) {
      return new Round((getTaxable() * (1.0 + getFullTax() / 100.0))).decimals(document.getCurrency().getDefaultFractionDigits()).value();
    } else {
      return getTaxable();
    }
  }

Here is the call graph for this function:

isEmpty()

boolean org.turro.financials.entity.DocumentLine.isEmpty

(

)

Definition at line 207 of file DocumentLine.java.

                           {
    return (Strings.isBlank(concept) &&
            getSubtotal() == 0) ||
            store == null;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

setConcept()

void org.turro.financials.entity.DocumentLine.setConcept

(

String

concept

)

Definition at line 70 of file DocumentLine.java.

                                         {
    if(!Strings.isBlank(concept)) {
      if(concept.length() > 255) {
        concept = concept.substring(0, 255);
      }
    }
    this.concept = concept;
  }

Here is the caller graph for this function:

setContractPreference()

void org.turro.financials.entity.DocumentLine.setContractPreference

(

ContractPreference

contractPreference

)

Definition at line 83 of file DocumentLine.java.

                                                                           {
    this.contractPreference = contractPreference;
  }

Here is the caller graph for this function:

setDiscountMoney()

void org.turro.financials.entity.DocumentLine.setDiscountMoney

(

double

discountMoney

)

Definition at line 91 of file DocumentLine.java.

                                                     {
    this.discountMoney = discountMoney;
  }

Here is the caller graph for this function:

setDiscountPerCent()

void org.turro.financials.entity.DocumentLine.setDiscountPerCent

(

double

discountPerCent

)

Definition at line 99 of file DocumentLine.java.

                                                         {
    this.discountPerCent = discountPerCent;
  }

Here is the caller graph for this function:

setDocument()

void org.turro.financials.entity.DocumentLine.setDocument

(

Document

document

)

Definition at line 107 of file DocumentLine.java.

                                             {
    this.document = document;
  }

Here is the caller graph for this function:

setEquivalenceSurcharge()

void org.turro.financials.entity.DocumentLine.setEquivalenceSurcharge

(

double

equivalenceSurcharge

)

Definition at line 201 of file DocumentLine.java.

                                                                   {
    this.equivalenceSurcharge = equivalenceSurcharge;
  }

Here is the caller graph for this function:

setId()

void org.turro.financials.entity.DocumentLine.setId

(

long

id

)

Definition at line 115 of file DocumentLine.java.

                             {
    this.id = id;
  }

setLineOrder()

void org.turro.financials.entity.DocumentLine.setLineOrder

(

int

lineOrder

)

Definition at line 123 of file DocumentLine.java.

                                          {
    this.lineOrder = lineOrder;
  }

Here is the caller graph for this function:

setLineType()

void org.turro.financials.entity.DocumentLine.setLineType

(

LineType

lineType

)

Definition at line 134 of file DocumentLine.java.

                                             {
    this.lineType = lineType;
    if(lineType != null && lineType.getContractPreference() != null) {
      contractPreference = lineType.getContractPreference();
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

setPrice()

void org.turro.financials.entity.DocumentLine.setPrice

(

double

price

)

Definition at line 145 of file DocumentLine.java.

                                     {
    this.price = price;
  }

Here is the caller graph for this function:

setProduct()

void org.turro.financials.entity.DocumentLine.setProduct

(

Product

product

)

Definition at line 153 of file DocumentLine.java.

                                          {
    this.product = product;
  }

Here is the caller graph for this function:

setProductByContractor()

void org.turro.financials.entity.DocumentLine.setProductByContractor

(

ProductByContractor

productByContractor

)

Definition at line 161 of file DocumentLine.java.

                                                                              {
    this.productByContractor = productByContractor;
  }

Here is the caller graph for this function:

setQuantity()

void org.turro.financials.entity.DocumentLine.setQuantity

(

double

quantity

)

Definition at line 169 of file DocumentLine.java.

                                           {
    this.quantity = quantity;
  }

Here is the caller graph for this function:

setRetention()

void org.turro.financials.entity.DocumentLine.setRetention

(

double

retention

)

Definition at line 177 of file DocumentLine.java.

                                             {
    this.retention = retention;
  }

Here is the caller graph for this function:

setStore()

void org.turro.financials.entity.DocumentLine.setStore

(

Contract

store

)

Definition at line 185 of file DocumentLine.java.

                                       {
    this.store = store;
  }

Here is the caller graph for this function:

setTax()

void org.turro.financials.entity.DocumentLine.setTax

(

double

tax

)

Definition at line 193 of file DocumentLine.java.

                                 {
    this.tax = tax;
  }

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• DocumentLine.java