DossierVisualElement.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2020 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.visual;
 
import java.util.Collection;
import java.util.EnumSet;
import java.util.HashSet;
import java.util.Set;
import org.turro.dossier.dossier.ParticipantSet;
import org.turro.dossier.entity.Dossier;
import org.turro.dossier.entity.Issue;
import org.turro.dossier.entity.IssueResolution;
import org.turro.dossier.entity.IssueType;
import org.turro.dossier.entity.ParticipantRole;
import org.turro.phase.PhaseType;
import org.turro.plugin.contacts.IContact;
 
public class DossierVisualElement extends VisualElement<DossierVisualElements, DossierVisualElement, Dossier> {
 
  private Set<Integer> phases;
  private EnumSet<PhaseType> phaseTypes;
  private EnumSet<ParticipantRole> roles;
  private HashSet<String> discriminators;
  private Boolean showAllAttachments, showParticipants, showAllIssues, receiveAllEmails, bindingVote, 
          driver, coordinator, beneficiary, offerer, research, funding, support;
  private Boolean directOwner, participates, branchAdmin;
 
  public DossierVisualElement(String name, DossierVisualElements factory) {
    super(name, factory);
  }
          
  public DossierVisualElement setShowAllAttachments(Boolean showAllAttachments) {
    this.showAllAttachments = showAllAttachments;
    return this;
  }
 
  public DossierVisualElement setShowParticipants(Boolean showParticipants) {
    this.showParticipants = showParticipants;
    return this;
  }
 
  public DossierVisualElement setShowAllIssues(Boolean showAllIssues) {
    this.showAllIssues = showAllIssues;
    return this;
  }
 
  public DossierVisualElement setReceiveAllEmails(Boolean receiveAllEmails) {
    this.receiveAllEmails = receiveAllEmails;
    return this;
  }
 
  public DossierVisualElement setBindingVote(Boolean bindingVote) {
    this.bindingVote = bindingVote;
    return this;
  }
 
  public DossierVisualElement setDriver(Boolean driver) {
    this.driver = driver;
    return this;
  }
 
  public DossierVisualElement setCoordinator(Boolean coordinator) {
    this.coordinator = coordinator;
    return this;
  }
 
  public DossierVisualElement setBeneficiary(Boolean beneficiary) {
    this.beneficiary = beneficiary;
    return this;
  }
 
  public DossierVisualElement setOfferer(Boolean offerer) {
    this.offerer = offerer;
    return this;
  }
 
  public DossierVisualElement setResearch(Boolean research) {
    this.research = research;
    return this;
  }
 
  public DossierVisualElement setFunding(Boolean funding) {
    this.funding = funding;
    return this;
  }
 
  public DossierVisualElement setSupport(Boolean support) {
    this.support = support;
    return this;
  }
  
  public DossierVisualElement setDirectOwner(Boolean directOwner) {
    this.directOwner = directOwner;
    return this;
  }
 
  public DossierVisualElement setParticipates(Boolean participates) {
    this.participates = participates;
    return this;
  }
 
  public DossierVisualElement setBranchAdmin(Boolean branchAdmin) {
    this.branchAdmin = branchAdmin;
    return this;
  }
 
  public DossierVisualElement addPhase(int phase) {
    if(phase > -1) { 
      if(phases == null) {
        phases = new HashSet<>();
      }
      phases.add(phase);
    }
    return this;
  }
  
  public DossierVisualElement addPhaseType(PhaseType type) {
    if(phaseTypes == null) {
      phaseTypes = EnumSet.of(type);
    } else {
      phaseTypes.add(type);
    }
    return this;
  }
  
  public DossierVisualElement addRole(ParticipantRole role) {
    if(roles == null) {
      roles = EnumSet.of(role);
    } else {
      roles.add(role);
    }
    return this;
  }
  
  public DossierVisualElement addDiscriminator(String discriminator) {
    if(discriminators == null) {
      discriminators = new HashSet<>();
    }
    discriminators.add(discriminator);
    return this;
  }
 
  @Override
  protected boolean emptyEntityConstraints() {
    return roles == null && discriminators == null && participates == null && 
           directOwner == null && branchAdmin == null && showAllAttachments == null && 
           showParticipants == null && showAllIssues == null && receiveAllEmails == null && 
           bindingVote == null && driver == null && coordinator == null && 
           beneficiary == null && offerer == null && research == null && 
           funding == null && support == null;
  }
 
  @Override
  protected boolean checkAllMatch(Dossier entity, IContact contact) {
    return entity.getProject() == null || (
           (phases == null || phases.contains(entity.getProject().getPhase())) &&
           (phaseTypes == null || entity.getProject().getPhaseDefinition().anyTypeMatch(phaseTypes)));
  }
 
  @Override
  protected boolean checkAnyMatch(Dossier entity, IContact contact) {
    ParticipantSet dpl = entity.getFullParticipants();
 
    return checkRoles(dpl, contact) ||
            checkDiscriminators(dpl, contact) ||
            checkAttributes(dpl, contact) ||
            checkDirectOwner(entity, contact) || 
            checkBranchAdmin(entity, contact) ||
            checkParticipates(dpl, contact);
  }
 
  @Override
  protected boolean checkEval(Dossier entity,IContact contact) {
    if(hasScript()) {
      getScript().addVariable("dossier", entity);
      getScript().addVariable("dpl", entity.getFullParticipants());
      return super.checkEval(entity, contact);
    }
    return false;
  }  
  
  private boolean checkRoles(ParticipantSet dpl, IContact contact) {
    if(roles != null) {
      for(ParticipantRole role : roles) {
        if(dpl.isRole(contact, role)) {
          return true;
        }
      }
    }
    return false;
  }
 
  private boolean checkDiscriminators(ParticipantSet dpl, IContact contact) {
    if(discriminators != null) {
      for(String discriminator : discriminators) {
        if(dpl.isParticipantByDiscriminator(contact, discriminator)) {
          return true;
        }
      }
    }
    return false;
  }
 
  private boolean checkAttributes(ParticipantSet dpl, IContact contact) {
    return (showAllAttachments == null ? false : showAllAttachments.equals(dpl.isShowAllAttachments(contact))) ||
           (showParticipants == null ? false : showParticipants.equals(dpl.isShowParticipants(contact))) ||
           (showAllIssues == null ? false : showAllIssues.equals(dpl.isShowAllIssues(contact))) ||
           (receiveAllEmails == null ? false : receiveAllEmails.equals(dpl.isReceiveAllEmails(contact))) ||
           (bindingVote == null ? false : bindingVote.equals(dpl.isBindingVote(contact))) ||
           (driver == null ? false : driver.equals(dpl.isDriver(contact))) ||
           (coordinator == null ? false : coordinator.equals(dpl.isCoordinator(contact))) ||
           (beneficiary == null ? false : beneficiary.equals(dpl.isBeneficiary(contact))) ||
           (offerer == null ? false : offerer.equals(dpl.isOfferer(contact))) ||
           (research == null ? false : research.equals(dpl.isResearch(contact))) ||
           (funding == null ? false : funding.equals(dpl.isFunding(contact))) ||
           (support == null ? false : support.equals(dpl.isSupport(contact))) ||
           (branchAdmin == null ? false : branchAdmin.equals(dpl.isAdmin(contact)));
  }
 
  private boolean checkParticipates(ParticipantSet dpl, IContact contact) {
    return isNullOrFalse(participates) ? false : dpl.isParticipant(contact);
  }
  
  private boolean checkDirectOwner(Dossier dossier, IContact contact) {
    return isNullOrFalse(directOwner) ? false : dossier.isDirectOwner(contact);
  }
  
  private boolean checkBranchAdmin(Dossier dossier, IContact contact) {
    return isNullOrFalse(branchAdmin) ? false : dossier.isBranchAdmin(contact);
  }
  
  /* Utility checks for sub-elements. Out of check() */
  
  public boolean isAdministrator(Dossier dossier, IContact contact) {
    return checkContact(contact) && dossier.isBranchAdmin(contact);
  }
  
  public boolean isPatron(IContact contact) {
    return checkContact(contact) && contact.getSyndications().contains("patron");
  }
  
  public boolean isInComission(Dossier dossier, IContact contact) {
    return checkContact(contact) && dossier.getFullParticipants().isParticipant(contact);
  }
  
  public boolean isPartner(IContact contact) {
    return checkContact(contact) && contact.getSyndications().contains("partner");
  }
  
  public boolean participatesAs(Dossier dossier, String discriminator, IContact contact) {
    return checkContact(contact) && dossier.getFullParticipants().isParticipantByDiscriminator(contact, discriminator);
  }
  
  public boolean participates(Dossier dossier, IContact contact) {
    return isNullOrFalse(participates) || (checkContact(contact) && dossier.getFullParticipants().isParticipant(contact));
  }
  
  public boolean isDirectOwner(Dossier dossier, IContact contact) {
    return isNullOrFalse(directOwner) || (checkContact(contact) && dossier.isDirectOwner(contact));
  }
  
  public boolean isOwnReporter(Issue issue, IContact contact) {
    return checkContact(contact) && issue.getIssueParticipants().isReporter(contact);
  }
  
  public boolean isWinReporter(Issue issue, IContact contact) {
    if(isOwnReporter(issue, contact)) {
      if(IssueResolution.RESOLUTION_FIXED.equals(issue.getResolution())) {
        return true;
      }
    }
    return false;
  }
  
  public boolean isOwnResponsible(Issue issue, IContact contact) {
    return checkContact(contact) && issue.getIssueParticipants().isResponsible(contact);
  }
  
  public boolean isWinResponsible(Issue issue, IContact contact) {
    if(isOwnResponsible(issue, contact)) {
      if(IssueResolution.RESOLUTION_FIXED.equals(issue.getResolution())) {
        return true;
      }
    }
    return false;
  }
  
  public boolean canShowOffer(Issue issue, IContact contact) {
    return (getSubElements() != null && getSubElements().getElement("Offer", issue.getDossier(), contact) != null) ||
            isOwnReporter(issue, contact);
  }
  
  public boolean canShowAddDocsOffer(Issue issue, IContact contact) {
    if((getSubElements() != null && getSubElements().getElement("Working Documents", issue.getDossier(), contact) != null) || 
            isOwnReporter(issue, contact)) {
      return true;
    }
    if((getSubElements() != null && getSubElements().getElement("Final Documents", issue.getDossier(), contact) != null) ||
            isWinReporter(issue, contact)) {
      return true;
    }
    return false;
  }
  
  public boolean canShowUploadOffer(Dossier dossier, IContact contact) {
    if(getSubElements() != null && getSubElements().getElement("Upload Offer", dossier, contact) != null) {
      return true;
    }
    return false;
  }
  
  public Collection<Issue> getIssuesByType(Dossier dossier, String type) {
    return dossier.getIssuesByType(IssueType.valueOf(type));
  }
  
  /* Offers */
  
  public boolean canShowOffer(Dossier dossier, IContact contact) {
    return (getSubElements() != null && getSubElements().getElement("Offer", dossier, contact) != null);
  }
  
  public boolean canAddWorkingOffer(Dossier dossier, IContact contact) {
    if((getSubElements() != null && getSubElements().getElement("Working Documents", dossier, contact) != null)) {
      return true;
    }
    return false;
  }
  
  public boolean canAddFinalOffer(Dossier dossier, IContact contact) {
    if((getSubElements() != null && getSubElements().getElement("Final Documents", dossier, contact) != null)) {
      return true;
    }
    return false;
  }
  
  public boolean canCreateOffer(Dossier dossier, IContact contact) {
    if(getSubElements() != null && getSubElements().getElement("Upload Offer", dossier, contact) != null) {
      return true;
    }
    return false;
  }
  
 
}