/**
    * Copyright 2005-2014 The Kuali Foundation
    *
    * Licensed under the Educational Community License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    * http://www.opensource.org/licenses/ecl2.php
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.kuali.rice.kew.engine.simulation;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.rice.core.api.exception.RiceRuntimeException;
  import org.kuali.rice.kew.actionrequest.KimPrincipalRecipient;
  import org.kuali.rice.kew.actionrequest.Recipient;
  import org.kuali.rice.kew.api.action.RoutingReportActionToTake;
  import org.kuali.rice.kew.api.action.RoutingReportCriteria;
  import org.kuali.rice.kew.service.KEWServiceLocator;
  import org.kuali.rice.kim.api.identity.Person;
  import org.kuali.rice.kim.api.identity.principal.Principal;
  import org.kuali.rice.kim.api.services.KimApiServiceLocator;
  
  import java.util.ArrayList;
  import java.util.List;
  
  /**
   * Criteria which acts as input to the {@link SimulationEngine}.
   *
   * @author Kuali Rice Team (rice.collab@kuali.org)
   * @see SimulationEngine
   */
  public class SimulationCriteria {
  
      // fields related to document simulation
      private String documentId;
      private String destinationNodeName;
      private List<Recipient> destinationRecipients = new ArrayList<Recipient>();
  
      // fields related to document type simulation
      private String documentTypeName;
      private String xmlContent;
      private List<String> nodeNames = new ArrayList<String>();
      private List<String> ruleTemplateNames = new ArrayList<String>();
  
      // fields related to both simulation types
      private Boolean activateRequests;
      private Person routingUser;
      private List<SimulationActionToTake> actionsToTake = new ArrayList<SimulationActionToTake>();
      private boolean flattenNodes;
  
      public SimulationCriteria() {
          this.activateRequests = null;
          this.flattenNodes = false;
      }
  
      public static SimulationCriteria createSimulationCritUsingDocumentId(String documentId) {
          return new SimulationCriteria(null, documentId);
      }
  
      public static SimulationCriteria createSimulationCritUsingDocTypeName(String documentTypeName) {
          return new SimulationCriteria(documentTypeName, null);
      }
  
      private SimulationCriteria(String documentTypeName, String documentId) {
          if (StringUtils.isNotBlank(documentId)) {
              this.documentId = documentId;
          } else if (StringUtils.isNotBlank(documentTypeName)) {
              this.documentTypeName = documentTypeName;
          }
      }
  
      public Boolean isActivateRequests() {
          return this.activateRequests;
      }
  
      public void setActivateRequests(Boolean activateRequests) {
          this.activateRequests = activateRequests;
      }
  
      public String getDocumentId() {
          return documentId;
      }
  
      public void setDocumentId(String documentId) {
          this.documentId = documentId;
      }
  
      public String getDestinationNodeName() {
          return destinationNodeName;
      }
  
      public void setDestinationNodeName(String destinationNodeName) {
          this.destinationNodeName = destinationNodeName;
     }
 
     public List<Recipient> getDestinationRecipients() {
         return destinationRecipients;
     }
 
     public void setDestinationRecipients(List<Recipient> destinationRecipients) {
         this.destinationRecipients = destinationRecipients;
     }
 
     public String getDocumentTypeName() {
         return documentTypeName;
     }
 
     public void setDocumentTypeName(String documentTypeName) {
         this.documentTypeName = documentTypeName;
     }
 
     public List<String> getRuleTemplateNames() {
         return ruleTemplateNames;
     }
 
     public void setRuleTemplateNames(List<String> ruleTemplateNames) {
         this.ruleTemplateNames = ruleTemplateNames;
     }
 
     public String getXmlContent() {
         return xmlContent;
     }
 
     public void setXmlContent(String xmlContent) {
         this.xmlContent = xmlContent;
     }
 
     public List<String> getNodeNames() {
         return nodeNames;
     }
 
     public void setNodeNames(List<String> nodeNames) {
         this.nodeNames = nodeNames;
     }
 
     public boolean isDocumentSimulation() {
         return documentId != null;
     }
 
     public boolean isDocumentTypeSimulation() {
         return !org.apache.commons.lang.StringUtils.isEmpty(documentTypeName);
     }
 
     public List<SimulationActionToTake> getActionsToTake() {
         return actionsToTake;
     }
 
     public void setActionsToTake(List<SimulationActionToTake> actionsToTake) {
         this.actionsToTake = actionsToTake;
     }
 
     public Person getRoutingUser() {
         return routingUser;
     }
 
     public void setRoutingUser(Person routingUser) {
         this.routingUser = routingUser;
     }
 
     public boolean isFlattenNodes() {
         return this.flattenNodes;
     }
 
     public void setFlattenNodes(boolean flattenNodes) {
         this.flattenNodes = flattenNodes;
     }
 
     public static SimulationCriteria from(RoutingReportCriteria criteriaVO) {
         if (criteriaVO == null) {
             return null;
         }
         SimulationCriteria criteria = new SimulationCriteria();
         criteria.setDestinationNodeName(criteriaVO.getTargetNodeName());
         criteria.setDocumentId(criteriaVO.getDocumentId());
         criteria.setDocumentTypeName(criteriaVO.getDocumentTypeName());
         criteria.setXmlContent(criteriaVO.getXmlContent());
         criteria.setActivateRequests(criteriaVO.isActivateRequests());
         criteria.setFlattenNodes(criteriaVO.isFlattenNodes());
         if (criteriaVO.getRoutingPrincipalId() != null) {
             Principal kPrinc = KEWServiceLocator.getIdentityHelperService().
                     getPrincipal(criteriaVO.getRoutingPrincipalId());
             Person user = KimApiServiceLocator.getPersonService().getPerson(kPrinc.getPrincipalId());
             if (user == null) {
                 throw new RiceRuntimeException(
                         "Could not locate user for the given id: " + criteriaVO.getRoutingPrincipalId());
             }
             criteria.setRoutingUser(user);
         }
         if (criteriaVO.getRuleTemplateNames() != null) {
             criteria.setRuleTemplateNames(criteriaVO.getRuleTemplateNames());
         }
         if (criteriaVO.getNodeNames() != null) {
             criteria.setNodeNames(criteriaVO.getNodeNames());
         }
         if (criteriaVO.getTargetPrincipalIds() != null) {
             for (String targetPrincipalId : criteriaVO.getTargetPrincipalIds()) {
                 Principal principal = KEWServiceLocator.getIdentityHelperService().getPrincipal(targetPrincipalId);
                 criteria.getDestinationRecipients().add(new KimPrincipalRecipient(principal));
             }
         }
 
         if (criteriaVO.getActionsToTake() != null) {
             for (RoutingReportActionToTake actionToTake : criteriaVO.getActionsToTake()) {
                 criteria.getActionsToTake().add(SimulationActionToTake.from(actionToTake));
             }
         }
 
         return criteria;
     }
 }