ReceiptItem.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.Collection;
import java.util.Date;
import java.util.Iterator;
import javax.persistence.*;
import org.turro.string.Strings;
import org.turro.contacts.Contact;
import org.turro.contacts.db.ContactsPU;
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 ReceiptItem 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;
  
  private String productDescription;
  
  @Column(name="START_WORKING")
  @Temporal(value = TemporalType.TIMESTAMP)
  private Date startWorking;
  
  private String receptorId;
 
  @ManyToOne
  private OrderItem orderItem;
  
  public double getCost() {
    return cost;
  }
 
  public void setCost(double cost) {
    this.cost = cost;
  }
 
  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 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 OrderItem getOrderItem() {
    return orderItem;
  }
 
  public void setOrderItem(OrderItem orderItem) {
    this.orderItem = orderItem;
  }
 
  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 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 String getReceptorId() {
    return receptorId;
  }
 
  public void setReceptorId(String receptorId) {
    this.receptorId = receptorId;
  }
 
  public Resource getResource() {
    return resource;
  }
 
  public void setResource(Resource resource) {
    this.resource = resource;
  }
 
  public Date getStartWorking() {
    return startWorking;
  }
 
  public void setStartWorking(Date startWorking) {
    this.startWorking = startWorking;
  }
 
  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 */
 
  private transient CachedEntity<Contact, String> receptor = 
          new CachedEntity<Contact, String>() {
    @Override
    protected Dao createDao() {
      return new ContactsPU();
    }
  };
  
  public Contact getPetitioner() {
    return receptor.getEntity(receptorId);
  }
 
  public void setPetitioner(Contact petitioner) {
    receptorId = this.receptor.setEntity(petitioner);
  }
 
  public boolean isEmpty() {
    return units == 0;
  }
 
  public boolean isProductType() {
    return ((providerProductId > 0 || productId > 0) ||
           !Strings.isEmpty(productDescription));
  }
  
  public boolean isHumanResourceType() {
    return humanResource != null;
  }
  
  public boolean isResourceType() {
    return resource != null;
  }
  
  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 Date getWorkDate() {
    return startWorking == null ? documentDate : startWorking;
  }
  
  public ReceiptStatus getStatus() {
    if(orderItem == null) {
      return ReceiptStatus.RECEIPT_READY;
    }
    if(orderItem.getUnits() <= units) {
      return ReceiptStatus.RECEIPT_PROCESSED;
    } else {
      return ReceiptStatus.RECEIPT_PROCESSED_PARTIALLY;
    }
  }
 
  public ReceiptItem getRelated() {
    OrderItem oi = orderItem != null ? orderItem.getRelated() : null;
    if(oi != null) {
      Collection<ReceiptItem> ris = oi.getReceiptItems();
      Iterator<ReceiptItem> itri = ris.iterator();
      if(itri.hasNext()) {
        return ris.iterator().next();
      }
    }
    return null;
  }
 
  public double getRealUnits() {
    return units * dedication;
  }
  
}