CrmEntities.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2017 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.entities;
 
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.turro.annotation.ElephantEntity;
import org.turro.collections.KeyValueMap;
import org.turro.command.LabelControl;
import org.turro.crm.db.CrmPU;
import org.turro.crm.entity.Campaign;
import org.turro.crm.entity.Customer;
import org.turro.crm.entity.SaleAction;
import org.turro.crm.entity.SaleProspect;
import org.turro.crm.entity.Vendor;
import org.turro.crm.entity.VendorProspect;
import org.turro.crm.zul.menu.CrmMenu;
import org.turro.elephant.db.WhereClause;
import org.turro.i18n.I_;
import org.turro.jpa.Dao;
import org.turro.path.Path;
import org.turro.plugin.contacts.IContact;
 
@ElephantEntity
public class CrmEntities extends DefaultElephantEntity {
 
  public CrmEntities() {
  }
 
  public CrmEntities(String entityPath) {
    super(entityPath);
  }
 
  public CrmEntities(Object entity) {
    super(entity);
  }
 
  @Override
  public Object getEntity() {
    if(entity == null) {
      if(getPath() != null) {
        if(isValidLongEntity()) {
          if(null != path.getRoot()) switch (path.getRoot()) {
            case "vendor":
              entity = getDao().find(Vendor.class, path.getNodeAs(1, Long.class));
              break;
            case "customer":
              entity =  getDao().find(Customer.class, path.getNodeAs(1, Long.class));
              break;
            case "campaign":
              entity =  getDao().find(Campaign.class, path.getNodeAs(1, Long.class));
              break;
            case "sale-prospect":
              entity =  getDao().find(SaleProspect.class, path.getNodeAs(1, Long.class));
              break;
            case "vendor-prospect":
              entity =  getDao().find(VendorProspect.class, path.getNodeAs(1, Long.class));
              break;
            case "sale-action":
              entity =  getDao().find(SaleAction.class, path.getNodeAs(1, Long.class));
              break;
            default:
              break;
          }
        }
      }
    }
    return entity;
  }
 
  @Override
  public String getName() {
    if(getEntity() != null) {
      if(entity instanceof Vendor) {
        return ((Vendor) entity).getName();
      } else if(entity instanceof Customer) {
        return ((Customer) entity).getName();
      } else if(entity instanceof Campaign) {
        return ((Campaign) entity).getDescription();
      } else if(entity instanceof SaleProspect) {
        return ((SaleProspect) entity).getFullDescription();
      } else if(entity instanceof SaleAction) {
        return ((SaleAction) entity).getComment();
      }
    }
    return null;
  }
 
  @Override
  public String getLabel() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "vendor":
          return I_.get("Vendor");
        case "customer":
          return I_.get("Customer");
        case "campaign":
          return I_.get("Campaign");
        case "sale-prospect":
          return I_.get("Sale prospect");
        case "vendor-prospect":
          return I_.get("Vendor prospect");
        case "sale-action":
          return I_.get("Sale action");
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getDescription() {
    return null;
  }
 
  @Override
  public Object getLabelCtrl() {
    if(getEntity() != null) {
      return new LabelControl(entity);
    }
    return null;
  }
 
  @Override
  public String getImage() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "vendor":
          return "/_zul/images/vendor.png";
        case "customer":
          return "/_zul/images/customer.png";
        case "campaign":
          return "/_zul/images/campaign.png";
        case "sale-prospect":
          return "/_zul/images/sale.png";
        case "sale-action":
          return "/_zul/images/appointment.png";
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getHierarchicalPath() {
    return getPath();
  }
 
  @Override
  public IElephantEntity getParent() {
    return null;
  }
 
  @Override
  public List<IElephantEntity> getChildren() {
    return Collections.EMPTY_LIST;
  }
 
  @Override
  public String getExtendedPath() {
    return "";
  }
 
  @Override
  public File getFile() {
    return null;
  }
 
  @Override
  public boolean showPath() {
    return false;
  }
 
  @Override
  public boolean showEntity() {
    if(getEntity() != null) {
      if(entity instanceof Vendor) {
        CrmMenu.showVendor(((Vendor) entity).getId());
        return true;
      } else if(entity instanceof Customer) {
        CrmMenu.showCustomer(((Customer) entity).getId());
        return true;
      } else if(entity instanceof Campaign) {
        CrmMenu.showCampaign(((Campaign) entity).getId());
        return true;
      } else if(entity instanceof SaleProspect) {
        CrmMenu.showSaleProspect(((SaleProspect) entity).getId());
        return true;
      } else if(entity instanceof SaleAction) {
        SaleAction sa = (SaleAction) entity;
        VendorProspect vp = sa.getVendorProspect();
        CrmMenu.showSaleActions(vp.getVendor(), vp.getSaleProspect());
        return true;
      }
    }
    return false;
  }
 
  @Override
  public boolean canEdit(IContact contact) {
    if(getEntity() != null) {
      if(entity instanceof Vendor) {
        return contact.getPermissions().isInRole("vendor:edit");
      } else if(entity instanceof Customer) {
        return contact.getPermissions().isInRole("customer:edit");
      } else if(entity instanceof Campaign) {
        return contact.getPermissions().isInRole("campaign:edit");
      } else if(entity instanceof SaleProspect) {
        return contact.getPermissions().isInRole("sale-prospect:edit");
      } else if(entity instanceof SaleAction) {
        return contact.getPermissions().isInRole("sale-action:edit");
      }
    }
    return false;
  }
 
  @Override
  public boolean canPublish(IContact contact) {
    if(getEntity() != null) {
      if(entity instanceof Vendor) {
        return contact.getPermissions().isInRole("vendor:list");
      } else if(entity instanceof Customer) {
        return contact.getPermissions().isInRole("customer:list");
      } else if(entity instanceof Campaign) {
        return contact.getPermissions().isInRole("campaign:list");
      } else if(entity instanceof SaleProspect) {
        return contact.getPermissions().isInRole("sale-prospect:list");
      } else if(entity instanceof SaleAction) {
        return contact.getPermissions().isInRole("sale-action:list");
      }
    }
    return false;
  }
 
  @Override
  public Collection getEntitites(String search, int maxResults, KeyValueMap kvm) {
    ArrayList<Object> list = new ArrayList<>();
    list.addAll(searchVendors(search, maxResults, kvm));
    list.addAll(searchCustomers(search, maxResults, kvm));
    return list;
  }
 
  @Override
  public Collection getEntitites(String root, String search, int maxResults, KeyValueMap kvm) {
    ArrayList<Object> list = new ArrayList<>();
    if(null != root) switch (root) {
      case "vendor":
        list.addAll(searchVendors(search, maxResults, kvm));
        break;
      case "customer":
        list.addAll(searchCustomers(search, maxResults, kvm));
        break;  
      default:
        break;
    }
    return list;
  }
 
  @Override
  public Object configureCtrl(Object ctrl, IContact contact) {
    return ctrl;
  }
 
  @Override
  public boolean canShowInContext(IContact contact, Object relatedEntity) {
    return true;
  }
 
  @Override
  public String getExtendedWebPath() {
    return null;
  }
 
  @Override
  public String getUserContext() {
    return null;
  }
 
  @Override
  protected Dao createDao() {
    return new CrmPU();
  }
 
  @Override
  protected boolean itsMine(String rootPath) {
    return getAllowedRoots().contains(rootPath);
  }
 
  @Override
  protected boolean itsMine(Object entity) {
    return (entity instanceof Vendor) || (entity instanceof Customer) ||
            (entity instanceof Campaign) || (entity instanceof SaleProspect) ||
            (entity instanceof VendorProspect) || (entity instanceof SaleAction);
  }
 
  @Override
  public Collection<String> getAllowedRoots() {
    return Arrays.asList("vendor", "customer", "campaign", "sale-prospect",
            "vendor-prospect", "sale-action");
  }
 
  @Override
  protected IElephantEntity createInstance(String entityPath) {
    return new CrmEntities(entityPath);
  }
 
  @Override
  protected IElephantEntity createInstance(Object entity) {
    return new CrmEntities(entity);
  }
 
  @Override
  protected Path createPath() {
    return new Path(CrmPU.getObjectPath(entity));
  }
 
  private List<Object> searchVendors(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from Vendor c");
    wc.addClause("where c.name like :search");
    wc.addClause("order by c.name");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
  private List<Object> searchCustomers(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from Customer c");
    wc.addClause("where c.name like :search");
    wc.addClause("order by c.name");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
}