OrderItem.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2012 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.erp.entity;
 
import java.util.Date;
import java.util.HashSet;
import java.util.Set;
import javax.persistence.*;
import org.turro.erp.db.ErpPU;
import org.turro.financials.db.FinancialsPU;
import org.turro.financials.entity.Contract;
import org.turro.financials.entity.DocumentLine;
import org.turro.financials.entity.Product;
import org.turro.financials.entity.ProductByContractor;
import org.turro.financials.product.CachedIProduct;
import org.turro.financials.product.IProduct;
import org.turro.financials.product.IProductKey;
import org.turro.jpa.Dao;
import org.turro.jpa.entity.CachedEntity;
 
@Entity
public class OrderItem implements java.io.Serializable {
 
  @Id
  @GeneratedValue(strategy=GenerationType.IDENTITY)
  @Column(name="IDENTIFIER")
  private long id;
 
  @Lob
  @Column(length=4096)
  private String description;
  
  private long providerId, providerProductId, productId, documentLineId;
 
  @ManyToOne
  private HumanResource humanResource;
  
  @ManyToOne
  private Resource resource;
  
  @Temporal(value = TemporalType.DATE)
  private Date documentDate;
  
  private String documentNumber;
  
  private double units, dedication, cost, tax, maxCost;
  
  private boolean costMaximum, providerFixed, sent;
  
  private String productDescription;
  
  @Column(name="DELIVERY_DATE")
  @Temporal(value = TemporalType.TIMESTAMP)
  private Date delivery;
  
  @ManyToOne
  private RequiredUsage requiredUsage;
  
  @OneToOne(cascade= CascadeType.ALL)
  private OrderItem related;
  
  @OneToMany(mappedBy = "orderItem", fetch = FetchType.LAZY)
  private Set<ReceiptItem> receiptItems = new HashSet<ReceiptItem>();
 
  public double getCost() {
    return cost;
  }
 
  public void setCost(double cost) {
    this.cost = cost;
  }
 
  public boolean isCostMaximum() {
    return costMaximum;
  }
 
  public void setCostMaximum(boolean costMaximum) {
    this.costMaximum = costMaximum;
  }
 
  public double getDedication() {
    return dedication;
  }
 
  public void setDedication(double dedication) {
    this.dedication = dedication;
  }
 
  public Date getDelivery() {
    return delivery;
  }
 
  public void setDelivery(Date delivery) {
    this.delivery = delivery;
  }
 
  public String getDescription() {
    return description;
  }
 
  public void setDescription(String description) {
    this.description = description;
  }
 
  public Date getDocumentDate() {
    return documentDate;
  }
 
  public void setDocumentDate(Date documentDate) {
    this.documentDate = documentDate;
  }
 
  public long getDocumentLineId() {
    return documentLineId;
  }
 
  public void setDocumentLineId(long documentLineId) {
    this.documentLineId = documentLineId;
  }
 
  public String getDocumentNumber() {
    return documentNumber;
  }
 
  public void setDocumentNumber(String documentNumber) {
    this.documentNumber = documentNumber;
  }
 
  public double getUnits() {
    return units;
  }
 
  public void setUnits(double units) {
    this.units = units;
  }
 
  public HumanResource getHumanResource() {
    return humanResource;
  }
 
  public void setHumanResource(HumanResource humanResource) {
    this.humanResource = humanResource;
  }
 
  public long getId() {
    return id;
  }
 
  public void setId(long id) {
    this.id = id;
  }
 
  public double getMaxCost() {
    return maxCost;
  }
 
  public void setMaxCost(double maxCost) {
    this.maxCost = maxCost;
  }
 
  public String getProductDescription() {
    return productDescription;
  }
 
  public void setProductDescription(String productDescription) {
    this.productDescription = productDescription;
  }
 
  public long getProductId() {
    return productId;
  }
 
  public void setProductId(long productId) {
    this.productId = productId;
  }
 
  public boolean isProviderFixed() {
    return providerFixed;
  }
 
  public void setProviderFixed(boolean providerFixed) {
    this.providerFixed = providerFixed;
  }
 
  public long getProviderId() {
    return providerId;
  }
 
  public void setProviderId(long providerId) {
    this.providerId = providerId;
  }
 
  public long getProviderProductId() {
    return providerProductId;
  }
 
  public void setProviderProductId(long providerProductId) {
    this.providerProductId = providerProductId;
  }
 
  public Set<ReceiptItem> getReceiptItems() {
    Dao dao = new ErpPU();
    if(id > 0 && dao.isNotLoaded(receiptItems)) {
      receiptItems = dao.lazyLoader(OrderItem.class, this, "receiptItems").receiptItems;
    }
    return receiptItems;
  }
 
  public Set<ReceiptItem> getUpdatedReceiptItems() {
    Dao dao = new ErpPU();
    if(id > 0) {
      receiptItems = dao.lazyLoader(OrderItem.class, this, "receiptItems").receiptItems;
    }
    return receiptItems;
  }
 
  public void setReceiptItems(Set<ReceiptItem> receiptItems) {
    this.receiptItems = receiptItems;
  }
 
  public OrderItem getRelated() {
    return related;
  }
 
  public void setRelated(OrderItem related) {
    this.related = related;
  }
 
  public RequiredUsage getRequiredUsage() {
    return requiredUsage;
  }
 
  public void setRequiredUsage(RequiredUsage requiredUsage) {
    this.requiredUsage = requiredUsage;
  }
 
  public Resource getResource() {
    return resource;
  }
 
  public void setResource(Resource resource) {
    this.resource = resource;
  }
 
  public boolean isSent() {
    return sent;
  }
 
  public void setSent(boolean sent) {
    this.sent = sent;
  }
 
  public double getTax() {
    return tax;
  }
 
  public void setTax(double tax) {
    this.tax = tax;
  }
 
  /* Financials Helpers */
  
  private transient CachedEntity<DocumentLine, Long> documentLine = 
          new CachedEntity<DocumentLine, Long>() {
    @Override
    protected Dao createDao() {
      return new FinancialsPU();
    }
  };
  
  public DocumentLine getDocumentLine() {
    return documentLine.getEntity(documentLineId);
  }
 
  public void setDocumentLine(DocumentLine documentLine) {
    documentLineId = this.documentLine.setEntity(documentLine);
  }
 
  private transient CachedEntity<Product, Long> product = 
          new CachedEntity<Product, Long>() {
    @Override
    protected Dao createDao() {
      return new FinancialsPU();
    }
  };
  
  public Product getProduct() {
    return product.getEntity(productId);
  }
 
  public void setProduct(Product product) {
    productId = this.product.setEntity(product);
  }
 
  private transient CachedIProduct iproduct = new CachedIProduct();
  
  public IProduct getIProduct() {
    return iproduct.getIProduct(new IProductKey(productId, providerId, providerProductId, productDescription));
  }
 
  public void setIProduct(IProduct product) {
    IProductKey productKey = iproduct.setIProduct(product);
    productId = productKey.getProductId();
    providerId = productKey.getProviderId();
    providerProductId = productKey.getProviderProductId();
    productDescription = productKey.getProductDescription();
  }
 
  private transient CachedEntity<Contract, Long> provider = 
          new CachedEntity<Contract, Long>() {
    @Override
    protected Dao createDao() {
      return new FinancialsPU();
    }
  };
  
  public Contract getProvider() {
    return provider.getEntity(providerId);
  }
 
  public void setProvider(Contract provider) {
    providerId = this.provider.setEntity(provider);
  }
 
  private transient CachedEntity<ProductByContractor, Long> providerProduct = 
          new CachedEntity<ProductByContractor, Long>() {
    @Override
    protected Dao createDao() {
      return new FinancialsPU();
    }
  };
  
  public ProductByContractor getProviderProduct() {
    return providerProduct.getEntity(providerProductId);
  }
 
  public void setProviderProduct(ProductByContractor providerProduct) {
    providerProductId = this.providerProduct.setEntity(providerProduct);
  }
 
  /* Helpers */
 
  public boolean isEmpty() {
    return units == 0;
  }
 
  public OrderItem getOwner() {
    return (OrderItem) new ErpPU().getSingleResultOrNull(
            "select oi from OrderItem oi " +
            "where related = ?",
            new Object[] { this });
  }
  
  public RequiredUsage getOwnerRequiredUsage() {
    if(requiredUsage == null) {
      OrderItem oi = getOwner();
      if(oi != null) {
        return oi.getRequiredUsage();
      }
    }
    return requiredUsage;
  }
  
  public String getName() {
    if(humanResource != null) {
      return humanResource.getName();
    } else if(resource != null) {
      return resource.getName();
    } else {
      IProduct product = getIProduct();
      return product != null ? product.getProductName() : null;
    }
  }
  
  public String getType() {
    if(humanResource != null) {
      return "operator";
    } else if(resource != null) {
      return "resource";
    } else {
      return "product";
    }
  }
  
  public double getAmount() {
    return cost * units * dedication;
  }
  
  public ReceiptItem startReceipt(Date startWorking) {
    return startReceipt(startWorking, units);
  }
  
  public ReceiptItem startReceipt(Date startWorking, double receiptUnits) {
    ReceiptItem ri = new ReceiptItem();
    ri.setOrderItem(this);
    ri.setDocumentDate(documentDate);
    ri.setDocumentNumber(documentNumber);
    ri.setHumanResource(humanResource);
    ri.setResource(resource);
    ri.setProductId(productId);
    ri.setProviderId(providerId);
    ri.setProviderProductId(providerProductId);
    ri.setProductDescription(productDescription);
    ri.setDescription(description);
    ri.setUnits(receiptUnits);
    ri.setDedication(dedication);
    ri.setStartWorking(startWorking);
    ri.setCost(cost);
    ri.setTax(tax);
    return ri;
  }
 
  /* Status helpers */
  
  public OrderStatus getStatus() {
    Set<ReceiptItem> lri = getReceiptItems();
    if(lri.isEmpty()) {
      if(isSent()) {
        return OrderStatus.ORDER_PENDING;
      } else {
        return OrderStatus.ORDER_READY;
      }
    }
    double tmp = 0.0;
    boolean processed = false;
    for(ReceiptItem ri : lri) {
      tmp += ri.getUnits();
      processed = true;
    }
    if(processed) {
      if(tmp >= units) {
        return OrderStatus.ORDER_RECEIVED;
      } else {
        return OrderStatus.ORDER_RECEIVED_PARTIALLY;
      }
    } else {
      return OrderStatus.ORDER_READY;
    }
  }
  
  public double getRealDedication() {
    double q = 0.0d, d = 0.0d;
    if(humanResource != null) {
      for(ReceiptItem ri : getReceiptItems()) {
        q += ri.getUnits();
        d += ri.getUnits() * ri.getDedication();
      }
    }
    return q != 0.0d ? d / q : 1.0d;
  }
  
  public double getExpectedUnits() {
    return units * dedication;
  }
  
  public double getRealUnits() {
    double q = 0.0d;
    for(ReceiptItem ri : getReceiptItems()) {
      q += ri.getUnits() * ri.getDedication();
    }
    return q;
  }
  
  public double getRealAmount() {
    double q = 0.0d;
    for(ReceiptItem ri : getReceiptItems()) {
      q += ri.getAmount();
    }
    return q;
  }
 
  public double convertToReal(double d) {
    return d / dedication;
  }
 
  public boolean hasReceipts() {
    boolean empty = getReceiptItems().isEmpty();
    if(empty && related != null) {
      empty = related.getReceiptItems().isEmpty();
    }
    return !empty;
  }
  
}