WorkOrder.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.HashSet;
import java.util.Iterator;
import java.util.Set;
import javax.persistence.*;
import org.amic.util.string.MultipleString;
import org.turro.string.Strings;
import org.turro.contacts.Contact;
import org.turro.contacts.db.ContactsPU;
import org.turro.elephant.db.IdUtils;
import org.turro.elephant.impl.util.StringParser;
import org.turro.erp.db.ErpPU;
import org.turro.financials.db.FinancialsPU;
import org.turro.financials.entity.Contract;
import org.turro.financials.entity.Product;
import org.turro.financials.entity.RegisterView;
import org.turro.jpa.Dao;
import org.turro.jpa.entity.CachedEntity;
 
@Entity
public class WorkOrder implements java.io.Serializable {
 
  @Id
  @GeneratedValue(strategy=GenerationType.IDENTITY)
  @Column(name="IDENTIFIER")
  private long id;
 
  private long productId;
  
  @Column(name="WORKORDER_DATE")
  @Temporal(value = TemporalType.DATE)
  private Date workOrderDate;
 
  @Lob
  @Column(length=4096)
  private String description;
 
  private long workOrderId;
 
  private long contractId;
  
  private String petitionerId;
 
  private long viewId;
  
  private boolean draft;
 
  @ManyToOne
  private OwnedAptitude supervised;
  
  @ManyToOne
  private WorkOrder parent;
 
  @OneToMany(mappedBy = "parent", fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval=true)
  private Set<WorkOrder> extensions = new HashSet<WorkOrder>();
 
  @OneToMany(mappedBy = "workOrder", fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval=true)
  @OrderBy(value="orderRef")
  private Set<OrderReference> orderReferences = new HashSet<OrderReference>();
 
  public long getContractId() {
    return contractId;
  }
 
  public void setContractId(long contractId) {
    this.contractId = contractId;
  }
 
  public String getDescription() {
    return description;
  }
 
  public void setDescription(String description) {
    this.description = description;
  }
 
  public boolean isDraft() {
    return draft;
  }
 
  public void setDraft(boolean draft) {
    this.draft = draft;
  }
 
  public Set<WorkOrder> getExtensions() {
    return extensions;
  }
 
  public void setExtensions(Set<WorkOrder> extensions) {
    this.extensions = extensions;
  }
 
  public long getId() {
    return id;
  }
 
  public void setId(long id) {
    this.id = id;
  }
 
  public Set<OrderReference> getOrderReferences() {
    return orderReferences;
  }
 
  public void setOrderReferences(Set<OrderReference> orderReferences) {
    this.orderReferences = orderReferences;
  }
 
  public WorkOrder getParent() {
    return parent;
  }
 
  public void setParent(WorkOrder parent) {
    this.parent = parent;
  }
 
  public String getPetitionerId() {
    return petitionerId;
  }
 
  public void setPetitionerId(String petitionerId) {
    this.petitionerId = petitionerId;
  }
 
  public long getProductId() {
    return productId;
  }
 
  public void setProductId(long productId) {
    this.productId = productId;
  }
 
  public OwnedAptitude getSupervised() {
    return supervised;
  }
 
  public void setSupervised(OwnedAptitude supervised) {
    this.supervised = supervised;
  }
 
  public long getViewId() {
    return viewId;
  }
 
  public void setViewId(long viewId) {
    this.viewId = viewId;
  }
 
  public Date getWorkOrderDate() {
    return workOrderDate;
  }
 
  public void setWorkOrderDate(Date workOrderDate) {
    this.workOrderDate = workOrderDate;
  }
 
  public long getWorkOrderId() {
    return workOrderId;
  }
 
  public void setWorkOrderId(long workOrderId) {
    this.workOrderId = workOrderId;
  }
 
  /* Financials Helpers */
 
  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 CachedEntity<Contract, Long> contract = 
          new CachedEntity<Contract, Long>() {
    @Override
    protected Dao createDao() {
      return new FinancialsPU();
    }
  };
  
  public Contract getContract() {
    return contract.getEntity(contractId);
  }
 
  public void setContract(Contract contract) {
    contractId = this.contract.setEntity(contract);
  }
 
  private transient CachedEntity<Contact, String> petitioner = 
          new CachedEntity<Contact, String>() {
    @Override
    protected Dao createDao() {
      return new ContactsPU();
    }
  };
  
  public Contact getPetitioner() {
    return petitioner.getEntity(petitionerId);
  }
 
  public void setPetitioner(Contact petitioner) {
    petitionerId = this.petitioner.setEntity(petitioner);
  }
 
  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);
  }
 
  /* Description Helper */
  
  public String getSomeDescription() {
    if(productId > 0) {
      Product p = getProduct();
      return p != null ? p.getProductString() : "";
    } else {
      if(!Strings.isBlank(description)) {
        return description;
      } else {
        MultipleString ms = new MultipleString();
        for(OrderReference or : getOrderReferences()) {
          ms.add(or.getSomeDescription());
        }
        return ms.getString(100);
      }
    }
  }
 
  public String getHtmlDescription() {
    return StringParser.toHTML(getSomeDescription());
  }
 
  /* Helpers */
 
  public boolean isProductOrder() {
    return productId > 0;
  }
  
  public boolean isEmpty() {
    boolean empty = workOrderDate == null;
    if(!empty) {
      empty = true;
      for(OrderReference or : orderReferences) {
        if(!or.isEmpty()) {
          empty = false;
          break;
        }
      }
    }
    return empty;
  }
 
  public void clearEmptyLines() {
    Iterator<OrderReference> it = orderReferences.iterator();
    while(it.hasNext()) {
      OrderReference or = it.next();
      if(or.isEmpty()) {
        or.setWorkOrder(null);
        it.remove();
      }
    }
  }
 
  public void prepareForSaving() {
    clearEmptyLines();
    for(WorkOrder wo : extensions) {
      wo.prepareForSaving();
    }
    for(OrderReference or : orderReferences) {
      or.prepareForSaving();
    }
    if(workOrderId == 0 && !draft) {
      workOrderId = IdUtils.getMaxLongIdFromLong(
              new ErpPU(), "WorkOrder", "workOrderId");
    }
  }
 
  public String getFullDescription() {
    return (isDraft() ? "" : workOrderId + " - ") + 
            Strings.truncateAndWarn(getSomeDescription(), 100);
  }
 
  public Set<OrderReference> getSavedOrderReferences() {
    HashSet<OrderReference> set = new HashSet<OrderReference>();
    for(OrderReference or : orderReferences) {
      if(or.getId() > 0) {
        set.add(or);
      }
    }
    return set;
  }
 
  public long getNextBudgetNumber() {
    long num = 1;
    for(OrderReference or : getOrderReferences()) {
      if(!or.isEmpty()) {
        for(Budget b : or.getBudgets()) {
          num = Math.max(num, b.getBudgetNumber() + 1);
        }
      }
    }
    return num;
  }
  
  public double getPrice() {
    double price = 0;
    for(OrderReference or : orderReferences) {
      price += or.getPrice();
    }
    return price;
  }
  
  public double getCost() {
    double cost = 0;
    for(OrderReference or : orderReferences) {
      cost += or.getCost();
    }
    return cost;
  }
  
  public static WorkOrder getByWorkOrderId(long value) {
    if(value > 0) {
      Dao dao = new ErpPU();
      return (WorkOrder) dao.getSingleResultOrNull(
              "select wo from WorkOrder as wo " +
              "where wo.workOrderId = ?",
              new Object[] { value });
    }
    return null;
  }
  
}