RequiredUsage.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.erp.entity;
 
import java.util.Date;
import java.util.EnumSet;
import java.util.HashSet;
import java.util.Set;
import javax.persistence.*;
import org.turro.string.Strings;
import org.turro.erp.db.ErpPU;
import org.turro.erp.resource.ResourceAptitude;
import org.turro.erp.task.UsageValuation;
import org.turro.financials.db.FinancialsPU;
import org.turro.financials.entity.Contract;
import org.turro.financials.entity.LineType;
import org.turro.financials.entity.Product;
import org.turro.financials.entity.ProductByContractor;
import org.turro.financials.entity.RegisterView;
import org.turro.financials.model.document.LineTypeDescription;
import org.turro.financials.product.IProduct;
import org.turro.financials.product.ProductFactory;
import org.turro.hr.humanres.HumanResourceAptitude;
import org.turro.jpa.Dao;
import org.turro.jpa.entity.CachedEntity;
import org.turro.math.Zero;
import org.turro.util.PhraseBuilder;
 
@Entity
public class RequiredUsage implements java.io.Serializable {
 
  @Id
  @GeneratedValue(strategy=GenerationType.IDENTITY)
  @Column(name="IDENTIFIER")
  private long id;
 
  private double units, cost, price, dedication, purchaseLag;
 
  private long providerId, providerProductId, productId, lineTypeId, contractPreferenceId, viewId;
  
  private boolean providerFixed, costMaximum, canChange, representHours;
  
  private String productDescription;
 
  @Lob
  @Column(length=4096)
  private String description;
  
  @ManyToOne
  private org.turro.erp.entity.Task task;
 
  @ManyToOne
  private org.turro.erp.entity.HumanResource humanResource;
  
  @ManyToOne
  private org.turro.erp.entity.Resource resource;
  
  @ManyToOne
  private AptitudeDegree aptitudeDegree;
 
  @ManyToOne
  private AptitudeDegree aptitudeAssesment;
  
  private PurchaseMode purchaseMode;
  
  @Temporal(value = TemporalType.DATE)
  private Date purchaseDate;
  
  @ManyToOne
  private org.turro.erp.entity.Task purchaseTask;
  
  @OneToMany(mappedBy = "requiredUsage", fetch = FetchType.LAZY)
  private Set<OrderItem> orderItems = new HashSet<OrderItem>();
 
  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 String getDescription() {
    return description;
  }
 
  public void setDescription(String description) {
    this.description = description;
  }
 
  public long getId() {
    return id;
  }
 
  public void setId(long id) {
    this.id = id;
  }
 
  public AptitudeDegree getAptitudeDegree() {
    return aptitudeDegree;
  }
 
  public void setAptitudeDegree(AptitudeDegree aptitudeDegree) {
    this.aptitudeDegree = aptitudeDegree;
  }
 
  public AptitudeDegree getAptitudeAssesment() {
    return aptitudeAssesment;
  }
 
  public void setAptitudeAssesment(AptitudeDegree aptitudeAssesment) {
    this.aptitudeAssesment = aptitudeAssesment;
  }
 
  public boolean isCanChange() {
    return canChange;
  }
 
  public void setCanChange(boolean canChange) {
    this.canChange = canChange;
  }
 
  public HumanResource getHumanResource() {
    return humanResource;
  }
 
  public void setHumanResource(HumanResource resource) {
    this.humanResource = resource;
  }
 
  public Set<OrderItem> getOrderItems() {
    Dao dao = new ErpPU();
    if(id > 0 && dao.isNotLoaded(orderItems)) {
      orderItems = dao.lazyLoader(RequiredUsage.class, this, "orderItems").orderItems;
    }
    return orderItems;
  }
 
  public Set<OrderItem> getUpdatedOrderItems() {
    Dao dao = new ErpPU();
    if(id > 0) {
      orderItems = dao.lazyLoader(RequiredUsage.class, this, "orderItems").orderItems;
    }
    return orderItems;
  }
 
  public void setOrderItems(Set<OrderItem> orderItems) {
    this.orderItems = orderItems;
  }
 
  public double getPrice() {
    return price;
  }
 
  public void setPrice(double price) {
    this.price = price;
  }
 
  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 Date getPurchaseDate() {
    return purchaseDate;
  }
 
  public long getLineTypeId() {
    return lineTypeId;
  }
 
  public void setLineTypeId(long lineTypeId) {
    this.lineTypeId = lineTypeId;
  }
 
  public long getContractPreferenceId() {
    return contractPreferenceId;
  }
 
  public void setContractPreferenceId(long contractPreferenceId) {
    this.contractPreferenceId = contractPreferenceId;
  }
 
  public void setPurchaseDate(Date purchaseDate) {
    this.purchaseDate = purchaseDate;
  }
 
  public double getPurchaseLag() {
    return purchaseLag;
  }
 
  public void setPurchaseLag(double purchaseLag) {
    this.purchaseLag = purchaseLag;
  }
 
  public PurchaseMode getPurchaseMode() {
    return purchaseMode;
  }
 
  public void setPurchaseMode(PurchaseMode purchaseMode) {
    this.purchaseMode = purchaseMode;
  }
 
  public Task getPurchaseTask() {
    return purchaseTask;
  }
 
  public void setPurchaseTask(Task purchaseTask) {
    this.purchaseTask = purchaseTask;
  }
 
  public boolean isRepresentHours() {
    return representHours;
  }
 
  public void setRepresentHours(boolean representHours) {
    this.representHours = representHours;
  }
 
  public Resource getResource() {
    return resource;
  }
 
  public void setResource(Resource resource) {
    this.resource = resource;
  }
 
  public Task getTask() {
    return task;
  }
 
  public void setTask(Task task) {
    this.task = task;
  }
 
  public double getUnits() {
    return units;
  }
 
  public void setUnits(double units) {
    this.units = units;
  }
 
  public long getViewId() {
    return viewId;
  }
 
  public void setViewId(long viewId) {
    this.viewId = viewId;
  }
 
  /* Financials Helpers */
  
  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<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);
  }
 
  public IProduct getIProduct() {
    return ProductFactory.getProduct(productId, providerId, providerProductId, productDescription);
  }
 
  public void setIProduct(IProduct product) {
    if(product != null) {
      if(product.isUncoded()) {
        productId = 0;
        productDescription = product.getProductCodeStr();
      } else {
        productId = ((Product) product).getId();
        if(product.getProductByContractor() != null) {
          setProviderProduct(product.getProductByContractor());
        } 
      }
    } else {
      productId = 0;
    }
  }
 
  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);
  }
 
  private transient CachedEntity<LineType, Long> lineType = 
          new CachedEntity<LineType, Long>() {
    @Override
    protected Dao createDao() {
      return new FinancialsPU();
    }
  };
  
  public LineType getLineType() {
    LineType lt = lineType.getEntity(lineTypeId);
    lt.setContractPreference(null);
    return lt;
  }
 
  public void setLineType(LineType lineType) {
    lineTypeId = this.lineType.setEntity(lineType);
  }
 
  private transient CachedEntity<RegisterView, Long> view = 
          new CachedEntity<RegisterView, Long>() {
    @Override
    protected Dao createDao() {
      return new FinancialsPU();
    }
  };
  
  public RegisterView getView() {
    return view.getEntity(viewId);
  }
 
  public void setView(RegisterView view) {
    viewId = this.view.setEntity(view);
  }
 
  /* Typers */
  
  protected transient int preparedType = 0;
 
  public boolean isProductType() {
    return ((providerProductId > 0 || productId > 0) ||
           !Strings.isEmpty(productDescription)) || preparedType == 2;
  }
  
  public boolean isHumanResourceType() {
    return (humanResource != null && aptitudeDegree != null) || preparedType == 1;
  }
  
  public boolean hasResource() {
    return isHumanResourceType() && resource != null;
  }
  
  public void prepareHumanResource() {
    providerProductId = 0;
    productId = 0;
    description = null;
    dedication = 1;
    preparedType = 1;
  }
  
  public void prepareProduct() {
    humanResource = null;
    aptitudeDegree = null;
    resource = null;
    dedication = 1;
    preparedType = 2;
  }
  
  /* Helpers */
 
  public boolean isEmpty() {
    clearEmptyLines();
    preparedType = 0;
    return (!isHumanResourceType() && !isProductType()) || units == 0.0d;
  }
 
  public void clearEmptyLines() {
  }
 
  public String getName() {
    if(isHumanResourceType()) {
      return getHumanResourceAptitude().getName() +
              (hasResource() ?
              " - " + getResource().getName() :
              "");
    } else if(isProductType()) {
      PhraseBuilder pb = new PhraseBuilder();
      IProduct p = getIProduct();
      if(p != null) {
        p.setProductByContractor(getProviderProduct());
        pb.addWord(p.getProductString());
      }
      if(!p.isUncoded()) {
        pb.addWord(getDescription());
      }
      String ltype = new LineTypeDescription(lineTypeId, contractPreferenceId).getDescription();
      if(ltype != null) {
        pb.addWord("(" + ltype + ")");
      }
      return pb.toString();
    }
    return null;
  }
 
  public String getType() {
    if(isHumanResourceType()) {
      return "operator";
    } else if(isProductType()) {
      return "product";
    }
    return null;
  }
  
  public HumanResourceAptitude getHumanResourceAptitude() {
    return new HumanResourceAptitude(humanResource, canChange, aptitudeDegree);
  }
  
  public void setHumanResourceAptitude(HumanResourceAptitude hro) {
    humanResource = hro.getHumanResource();
    aptitudeDegree = hro.getAptitudeDegree();
  }
  
  public HumanResourceAptitude getHumanResourceAptitudeAssest() {
    return new HumanResourceAptitude(humanResource, canChange,
            aptitudeAssesment == null ? aptitudeDegree : aptitudeAssesment);
  }
  
  public ResourceAptitude getResourceAptitude() {
    return new ResourceAptitude(resource, aptitudeDegree);
  }
  
  public void setResourceAptitude(ResourceAptitude ro) {
    if(ro != null) {
      resource = ro.getResource();
      aptitudeDegree = ro.getAptitudeDegree();
    }
  }
  
  public boolean fits(HumanResource humanResource) {
    return this.humanResource != null && 
           ((this.humanResource.getId() == humanResource.getId()) ||
             humanResource.fits(aptitudeDegree, new Date()));           
  }
 
  public boolean isInternal() {
    return (humanResource != null && humanResource.isInternal()) ||
            (resource != null && resource.isInternal());
  }
  
  private transient double orderUnits = 0.0d;
 
  public double getOrderUnits() {
    return orderUnits;
  }
 
  public void setOrderUnits(double orderUnits) {
    this.orderUnits = orderUnits;
  }
  
  public OrderItem startOrder() {
    return startOrder(orderUnits == 0.0d ? getUnits() : orderUnits);
  }
  
  public OrderItem startOrder(double orderUnits) {
    OrderItem oi = new OrderItem();
    oi.setSent(false);
    oi.setDocumentDate(null);
    oi.setDocumentNumber("");
    oi.setRequiredUsage(this);
    oi.setUnits(orderUnits);
    oi.setDelivery(task.getDelivery());
    oi.setDescription(description);
    if(isHumanResourceType()) {
      oi.setHumanResource(humanResource);
      oi.setProviderId(humanResource.getIdContract());
      oi.setDedication(dedication);
      oi.setCost(getHumanResourceAptitude().getCost());
      oi.setTax(0);
      oi.setProviderFixed(true);
      if(hasResource()) {
        OrderItem oir = new OrderItem();
        oir.setSent(false);
        oir.setDocumentDate(null);
        oir.setDocumentNumber("");
        oir.setRequiredUsage(null);
        oir.setResource(resource);
        oir.setProviderId(resource.getIdContract());
        oir.setUnits(orderUnits);
        oir.setDelivery(task.getDelivery());
        oir.setDedication(1.0d);
        oir.setCost(resource.getCostHour());
        oir.setTax(0);
        oir.setProviderFixed(true);
        oi.setRelated(oir);
      }
    } else if(isProductType()) {
      oi.setProductId(productId);
      oi.setProviderProductId(providerProductId);
      oi.setProviderId(providerId);
      oi.setProviderFixed(providerFixed);
      oi.setProductDescription(productDescription);
      oi.setDedication(1.0d);
      oi.setCost(cost);
      oi.setCostMaximum(costMaximum);
      if(isCostMaximum()) {
        oi.setMaxCost(cost);
      }
      oi.setTax(0);
    }
    return oi;
  }
  
  /* Status helpers */
  
  public UsageStatus getStatus() {
    double estimatedUnits = getEstimatedUnits(),
           expectedUnits = getExpectedUnits(),
           realUnits = getRealUnits();
    if(realUnits == 0.0d) {
      if(expectedUnits != 0.0d) {
        return UsageStatus.USAGE_PENDING;
      } else {
        return UsageStatus.USAGE_READY;
      }
    } else {
      if(realUnits >= estimatedUnits) {
        if(EnumSet.of(TaskStatus.TASK_FINISHED, TaskStatus.TASK_ONWORK).contains(getTask().getStatus())) {
          return UsageStatus.USAGE_PROCESSED;
        } else {
          return UsageStatus.USAGE_RECEIVED;
        }
      } else {
        return UsageStatus.USAGE_RECEIVED_PARTIALLY;
      }
    }
  }
 
  public long getResourceId() {
    if(isHumanResourceType()) {
      return getHumanResource().getId();
    } else if(isProductType()) {
      return getProductId();
    }
    return 0;
  }
 
  public double getEstimatedDuration() {
    double q = 0.0;
    if(isHumanResourceType()/* || representHours*/) {
      q += getUnits();
    }
    return q;
  }
  
  public double getExpectedDuration() {
    double q = 0.0;
    if(isHumanResourceType()) {
      for(OrderItem oi : getOrderItems()) {
        q += oi.getUnits();
      }
    }
    return q;
  }
  
  public double getRealDuration() {
    double q = 0.0;
    if(isHumanResourceType()) {
      for(OrderItem oi : getOrderItems()) {
        for(ReceiptItem ri : oi.getReceiptItems()) {
          q += ri.getUnits();
        }
      }
    }
    return q;
  }
  
  public double getExpectedDedication() {
    double q = 0.0d, d = 0.0d;
    if(isHumanResourceType()) {
      for(OrderItem oi : getOrderItems()) {
        q += oi.getUnits();
        d += oi.getUnits() * oi.getDedication();
      }
    }
    return q != 0.0d ? d / q : 1.0d;
  }
  
  public double getRealDedication() {
    double q = 0.0d, d = 0.0d;
    if(isHumanResourceType()) {
      for(OrderItem oi : getOrderItems()) {
        for(ReceiptItem ri : oi.getReceiptItems()) {
          q += ri.getUnits();
          d += ri.getUnits() * ri.getDedication();
        }
      }
    }
    return q != 0.0d ? d / q : 1.0d;
  }
  
  public double getEstimatedUnits() {
    if(isHumanResourceType()) {
      return (units * dedication) + (
              hasResource() ? units : 0);
    } else {
      return units;
    }
  }
  
  public double getCalculatedUnitCost() {
    return new UsageValuation(this).getUnitCost();
  }
  
  public double getEstimatedUnitCost() {
    if(Zero.near(cost, 2)) {
      return getCalculatedUnitCost();
    }
    return cost;
  }
  
  public double getEstimatedCost() {
    return getEstimatedUnitCost() * getEstimatedUnits();
  }
  
  public double getExpectedUnits() {
    double q = 0.0d;
    for(OrderItem oi : getOrderItems()) {
      q += oi.getUnits() * oi.getDedication();
      if(oi.getRelated() != null) {
        q += oi.getRelated().getUnits() * oi.getRelated().getDedication();
      }
    }
    return q;
  }
 
  public double getExpectedUnitCost() {
    return getExpectedCost() / getExpectedUnits();
  }
  
  public double getExpectedCost() {
    double q = 0.0d;
    for(OrderItem oi : getOrderItems()) {
      q += oi.getAmount();
      if(oi.getRelated() != null) {
        q += oi.getRelated().getAmount();
      }
    }
    return q;
  }
 
  public double getRealUnits() {
    double q = 0.0d;
    for(OrderItem oi : getOrderItems()) {
      q += oi.getRealUnits();
      if(oi.getRelated() != null) {
        q += oi.getRelated().getRealUnits();
      }
    }
    return q;
  }
 
  public double getRealUnitCost() {
    double rc = getRealCost(),
           ru = getRealUnits(),
           result = rc / ru;
    return Double.isNaN(result) ? 0.0d : result;
  }
  
  public double getRealCost() {
    double q = 0.0d;
    for(OrderItem oi : getOrderItems()) {
      q += oi.getRealAmount();
      if(oi.getRelated() != null) {
        q += oi.getRelated().getRealAmount();
      }
    }
    return q;
  }
 
  public double getEstimatedPrice() {
    return getEstimatedUnits() * getUnitPrice();
  }
 
  public double getProposedPrice() {
    return getRealUnits() * getUnitPrice();
  }
 
  public double getUnitPrice() {
    if(Zero.near(price, 2)) {
      return new UsageValuation(this).getUnitPrice();
    }
    return price;
  }
 
  public double convertToReal(double convertedUnits) {
    return (units * convertedUnits) / getEstimatedUnits();
  }
 
  public double getMostRealCost() {
    double mostRealCost = getRealCost();
    if(mostRealCost == 0.0) {
      mostRealCost = getExpectedCost();
    }
    if(mostRealCost == 0.0) {
      mostRealCost = getEstimatedCost();
    }
    return mostRealCost;
  }
  
}