/*
    * The Kuali Financial System, a comprehensive financial management system for higher education.
    * 
    * Copyright 2005-2014 The Kuali Foundation
    * 
    * 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.kuali.kfs.module.purap.document.validation.impl;
  
  import java.util.HashMap;
  import java.util.Map;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.kfs.module.purap.PurapKeyConstants;
  import org.kuali.kfs.module.purap.PurapPropertyConstants;
  import org.kuali.kfs.module.purap.businessobject.PurApItem;
  import org.kuali.kfs.module.purap.businessobject.PurchasingItemBase;
  import org.kuali.kfs.sys.KFSKeyConstants;
  import org.kuali.kfs.sys.document.validation.GenericValidation;
  import org.kuali.kfs.sys.document.validation.event.AttributedDocumentEvent;
  import org.kuali.kfs.vnd.businessobject.CommodityCode;
  import org.kuali.rice.kns.service.DataDictionaryService;
  import org.kuali.rice.krad.service.BusinessObjectService;
  import org.kuali.rice.krad.util.GlobalVariables;
  
  public class PurchasingCommodityCodeValidation extends GenericValidation {
      
      private BusinessObjectService businessObjectService;
      private DataDictionaryService dataDictionaryService;
      private PurApItem itemForValidation;
      
      public boolean validate(AttributedDocumentEvent event) {
          boolean valid = true;
          GlobalVariables.getMessageMap().clearErrorPath();                
          GlobalVariables.getMessageMap().addToErrorPath("document.item[" + (itemForValidation.getItemLineNumber() - 1) + "]");
  
          itemForValidation.refreshReferenceObject(PurapPropertyConstants.COMMODITY_CODE);
          valid &= validateCommodityCodes(itemForValidation, commodityCodeIsRequired());
          
          GlobalVariables.getMessageMap().removeFromErrorPath("document.item[" + (itemForValidation.getItemLineNumber() - 1) + "]");
  
          return valid;
  
      }
      
      public PurApItem getItemForValidation() {
          return itemForValidation;
      }
  
      public void setItemForValidation(PurApItem itemForValidation) {
          this.itemForValidation = itemForValidation;
      }
  
      /**
       * Validates whether the commodity code existed on the item, and if existed, whether the
       * commodity code on the item existed in the database, and if so, whether the commodity 
       * code is active. Display error if any of these 3 conditions are not met.
       * 
       * @param item  The PurApItem containing the commodity code to be validated.
       * @return boolean false if the validation fails and true otherwise.
       */
      protected boolean validateCommodityCodes(PurApItem item, boolean commodityCodeRequired) {
          boolean valid = true;
          String identifierString = item.getItemIdentifierString();
          PurchasingItemBase purItem = (PurchasingItemBase) item;
          
          //This validation is only needed if the commodityCodeRequired system parameter is true
          if (commodityCodeRequired && StringUtils.isBlank(purItem.getPurchasingCommodityCode()) ) {
              //This is the case where the commodity code is required but the item does not currently contain the commodity code.
              valid = false;
              String attributeLabel = dataDictionaryService.
                                      getDataDictionary().getBusinessObjectEntry(CommodityCode.class.getName()).
                                      getAttributeDefinition(PurapPropertyConstants.ITEM_COMMODITY_CODE).getLabel();
              GlobalVariables.getMessageMap().putError(PurapPropertyConstants.ITEM_COMMODITY_CODE, KFSKeyConstants.ERROR_REQUIRED, attributeLabel + " in " + identifierString);
          }
          else if (StringUtils.isNotBlank(purItem.getPurchasingCommodityCode())) {
              //Find out whether the commodity code has existed in the database
              Map<String,String> fieldValues = new HashMap<String, String>();
              fieldValues.put(PurapPropertyConstants.ITEM_COMMODITY_CODE, purItem.getPurchasingCommodityCode());
              if (businessObjectService.countMatching(CommodityCode.class, fieldValues) != 1) {
                  //This is the case where the commodity code on the item does not exist in the database.
                  valid = false;
                  GlobalVariables.getMessageMap().putError(PurapPropertyConstants.ITEM_COMMODITY_CODE, PurapKeyConstants.PUR_COMMODITY_CODE_INVALID,  " in " + identifierString);
              }
              else {
                  valid &= validateThatCommodityCodeIsActive(item);
              }
          }
         
         return valid;
     }
 
     protected boolean validateThatCommodityCodeIsActive(PurApItem item) {
         if (!((PurchasingItemBase)item).getCommodityCode().isActive()) {
             //This is the case where the commodity code on the item is not active.
             GlobalVariables.getMessageMap().putError(PurapPropertyConstants.ITEM_COMMODITY_CODE, PurapKeyConstants.PUR_COMMODITY_CODE_INACTIVE, " in " + item.getItemIdentifierString());
             return false;
         }
         return true;
     }
 
     /**
      * Predicate to do a parameter lookup and tell us whether a commodity code is required.
      * Override in child classes. 
      * 
      * @return      True if a commodity code is required.
      */
     protected boolean commodityCodeIsRequired() {
         return false;
     }
 
     public BusinessObjectService getBusinessObjectService() {
         return businessObjectService;
     }
 
     public void setBusinessObjectService(BusinessObjectService businessObjectService) {
         this.businessObjectService = businessObjectService;
     }
 
     public DataDictionaryService getDataDictionaryService() {
         return dataDictionaryService;
     }
 
     public void setDataDictionaryService(DataDictionaryService dataDictionaryService) {
         this.dataDictionaryService = dataDictionaryService;
     }
 
 }