DocumentLine.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2011 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.turro.financials.entity;
 
import javax.persistence.*;
import org.turro.string.Strings;
import org.turro.math.Round;
 
@Entity
public class DocumentLine implements java.io.Serializable {
 
  @Id
  @GeneratedValue(strategy=GenerationType.IDENTITY)
  @Column(name="IDENTIFIER")
  private long id;
 
  @ManyToOne
  private Document document;
 
  @ManyToOne
  private Contract store;
 
  private int lineOrder;
 
  @ManyToOne
  private Product product;
 
  @ManyToOne
  private ProductByContractor productByContractor;
 
  private String concept;
 
  private double quantity;
  private double price;
  private double tax;
  private double equivalenceSurcharge;
  private double discountPerCent;
  private double discountMoney;
  private double retention;
 
  @ManyToOne
  private LineType lineType;
 
  @ManyToOne
  private ContractPreference contractPreference;
 
  public String getConcept() {
    return concept;
  }
 
  public void setConcept(String concept) {
    if(!Strings.isBlank(concept)) {
      if(concept.length() > 255) {
        concept = concept.substring(0, 255);
      }
    }
    this.concept = concept;
  }
 
  public ContractPreference getContractPreference() {
    return contractPreference;
  }
 
  public void setContractPreference(ContractPreference contractPreference) {
    this.contractPreference = contractPreference;
  }
 
  public double getDiscountMoney() {
    return discountMoney;
  }
 
  public void setDiscountMoney(double discountMoney) {
    this.discountMoney = discountMoney;
  }
 
  public double getDiscountPerCent() {
    return discountPerCent;
  }
 
  public void setDiscountPerCent(double discountPerCent) {
    this.discountPerCent = discountPerCent;
  }
 
  public Document getDocument() {
    return document;
  }
 
  public void setDocument(Document document) {
    this.document = document;
  }
 
  public long getId() {
    return id;
  }
 
  public void setId(long id) {
    this.id = id;
  }
 
  public int getLineOrder() {
    return lineOrder;
  }
 
  public void setLineOrder(int lineOrder) {
    this.lineOrder = lineOrder;
  }
 
  public LineType getLineType() {
    if(lineType != null) {
      lineType.setContractPreference(contractPreference);
    }
    return lineType;
  }
 
  public void setLineType(LineType lineType) {
    this.lineType = lineType;
    if(lineType != null && lineType.getContractPreference() != null) {
      contractPreference = lineType.getContractPreference();
    }
  }
 
  public double getPrice() {
    return price;
  }
 
  public void setPrice(double price) {
    this.price = price;
  }
 
  public Product getProduct() {
    return product;
  }
 
  public void setProduct(Product product) {
    this.product = product;
  }
 
  public ProductByContractor getProductByContractor() {
    return productByContractor;
  }
 
  public void setProductByContractor(ProductByContractor productByContractor) {
    this.productByContractor = productByContractor;
  }
 
  public double getQuantity() {
    return quantity;
  }
 
  public void setQuantity(double quantity) {
    this.quantity = quantity;
  }
 
  public double getRetention() {
    return retention;
  }
 
  public void setRetention(double retention) {
    this.retention = retention;
  }
 
  public Contract getStore() {
    return store;
  }
 
  public void setStore(Contract store) {
    this.store = store;
  }
 
  public double getTax() {
    return tax;
  }
 
  public void setTax(double tax) {
    this.tax = tax;
  }
 
  public double getEquivalenceSurcharge() {
    return equivalenceSurcharge;
  }
 
  public void setEquivalenceSurcharge(double equivalenceSurcharge) {
    this.equivalenceSurcharge = equivalenceSurcharge;
  }
 
  /* Helpers */
 
  public boolean isEmpty() {
    return (Strings.isBlank(concept) &&
            getSubtotal() == 0) ||
            store == null;
  }
 
  public void clearLine() {
    setProduct(null);
    setProductByContractor(null);
    setConcept(null);
    setQuantity(0);
    setPrice(0);
    setTax(0);
    setDiscountPerCent(0);
    setDiscountMoney(0);
  }
 
  public String getDescription() {
    if(product != null) {
      return product.getDescription();
    }
    if(productByContractor != null && productByContractor.getProduct() != null) {
      return productByContractor.getProduct().getDescription();
    }
    return null;
  }
 
  public double getSubtotal() {
    int fractions = document.getCurrency() == null ? 2 : document.getCurrency().getDefaultFractionDigits();
    return new Round(quantity == 0 ? price : price * quantity).decimals(fractions).value();
  }
 
  public double getRetained() {
    return new Round((getSubtotal() - getDiscount()) * (retention / 100.0)).decimals(document.getCurrency().getDefaultFractionDigits()).value();
  }
 
  public double getDiscount() {
    return new Round(((getSubtotal() - discountMoney) * (discountPerCent / 100.0)) + discountMoney).decimals(document.getCurrency().getDefaultFractionDigits()).value();
  }
 
  public Double getTaxable() {
    return new Round(getSubtotal() - getDiscount()).decimals(document.getCurrency().getDefaultFractionDigits()).value();
  }
 
  public Double getFullTaxValue() {
    return (getAmount() + getRetained()) - getTaxable();
  }
  
  public Double getTaxValue() {
    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;
    }
  }
  
  public Double getRealTaxValue() {
    if(tax != 0) {
      if(equivalenceSurcharge != 0) {
        return new Round(getFullTaxValue() * tax / getFullTax()).decimals(document.getCurrency().getDefaultFractionDigits()).value();
      } else {
        return getTaxValue();
      }
    }
    return 0.0;
  }
  
  public Double getEquivalenceSurchargeValue() {
    if(equivalenceSurcharge > 0) {
      return getFullTaxValue() - getRealTaxValue();
    }
    return 0.0;
  }
 
  public Double getAmount() {
    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();
    }
  }
 
  public Double getToDeclare() {
    if(document.getContract().getOperatingModifier().isSumTax(this)) {
      return new Round((getTaxable() * (1.0 + getFullTax() / 100.0))).decimals(document.getCurrency().getDefaultFractionDigits()).value();
    } else {
      return getTaxable();
    }
  }
 
  public Double getFullTax() {
    return tax + equivalenceSurcharge;
  }
  
  public void assignValuesFrom(DocumentLine documentLine) {
    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());
  }
 
}