/*
    * Copyright 2008 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.ole.module.purap.document.validation.impl;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.ole.integration.cab.CapitalAssetBuilderModuleService;
  import org.kuali.ole.module.purap.PurapConstants;
  import org.kuali.ole.module.purap.PurapKeyConstants;
  import org.kuali.ole.module.purap.PurapPropertyConstants;
  import org.kuali.ole.module.purap.businessobject.PurApItem;
  import org.kuali.ole.module.purap.businessobject.PurchasingItemBase;
  import org.kuali.ole.module.purap.document.PurchasingDocument;
  import org.kuali.ole.sys.OLEKeyConstants;
  import org.kuali.ole.sys.document.validation.event.AttributedDocumentEvent;
  import org.kuali.ole.vnd.businessobject.CommodityCode;
  import org.kuali.rice.krad.service.BusinessObjectService;
  import org.kuali.rice.krad.util.GlobalVariables;
  
  import java.util.HashMap;
  import java.util.Map;
  
  public class PurchasingNewIndividualItemValidation extends PurchasingAccountsPayableNewIndividualItemValidation {
  
      private BusinessObjectService businessObjectService;
      private CapitalAssetBuilderModuleService capitalAssetBuilderModuleService;
      private PurchasingUnitOfMeasureValidation unitOfMeasureValidation;
      private PurchasingItemUnitPriceValidation itemUnitPriceValidation;
      private PurchasingItemDescriptionValidation itemDescriptionValidation;
      private PurchasingItemQuantityValidation itemQuantityValidation;
      private PurchasingBelowTheLineItemNoUnitCostValidation belowTheLineItemNoUnitCostValidation;
  
      public boolean validate(AttributedDocumentEvent event) {
          boolean valid = true;
          valid &= super.validate(event);
          String recurringPaymentTypeCode = ((PurchasingDocument) event.getDocument()).getRecurringPaymentTypeCode();
          //Capital asset validations are only done on line items (not additional charge items).
          if (!getItemForValidation().getItemType().isAdditionalChargeIndicator()) {
              valid &= capitalAssetBuilderModuleService.validateItemCapitalAssetWithErrors(recurringPaymentTypeCode, getItemForValidation(), false);
          }
          unitOfMeasureValidation.setItemForValidation(getItemForValidation());
          valid &= unitOfMeasureValidation.validate(event);
  
          if (getItemForValidation().getItemType().isLineItemIndicator()) {
              itemUnitPriceValidation.setItemForValidation(getItemForValidation());
              valid &= itemUnitPriceValidation.validate(event);
  
              itemDescriptionValidation.setItemForValidation(getItemForValidation());
              valid &= itemDescriptionValidation.validate(event);
  
              itemQuantityValidation.setItemForValidation(getItemForValidation());
              valid &= itemQuantityValidation.validate(event);
  
              valid &= validateCommodityCodes(getItemForValidation(), commodityCodeIsRequired());
          } else {
              // No accounts can be entered on below-the-line items that have no unit cost.
              belowTheLineItemNoUnitCostValidation.setItemForValidation(getItemForValidation());
              valid &= belowTheLineItemNoUnitCostValidation.validate(event);
          }
          return valid;
      }
  
      protected boolean commodityCodeIsRequired() {
          return false;
      }
  
      /**
       * Validates that the document contains at least one item.
       *
       * @param purDocument the purchasing document to be validated
       * @return boolean false if the document does not contain at least one item.
       */
      public boolean validateContainsAtLeastOneItem(PurchasingDocument purDocument) {
          boolean valid = false;
          for (PurApItem item : purDocument.getItems()) {
              if (!((PurchasingItemBase) item).isEmpty() && item.getItemType().isLineItemIndicator()) {
  
                  return true;
              }
          }
          String documentType = getDocumentTypeLabel(purDocument.getDocumentHeader().getWorkflowDocument().getDocumentTypeName());
  
          if (!valid) {
              GlobalVariables.getMessageMap().putError(PurapConstants.ITEM_TAB_ERROR_PROPERTY, PurapKeyConstants.ERROR_ITEM_REQUIRED, documentType);
          }
  
          return valid;
     }
 
     /**
      * 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 = getDataDictionaryService().getDataDictionary().getBusinessObjectEntry(CommodityCode.class.getName()).
                     getAttributeDefinition(PurapPropertyConstants.ITEM_COMMODITY_CODE).getLabel();
             GlobalVariables.getMessageMap().putError(PurapPropertyConstants.ITEM_COMMODITY_CODE, OLEKeyConstants.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) {
         item.refreshReferenceObject(PurapPropertyConstants.COMMODITY_CODE);
         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;
     }
 
     public BusinessObjectService getBusinessObjectService() {
         return businessObjectService;
     }
 
     public void setBusinessObjectService(BusinessObjectService businessObjectService) {
         this.businessObjectService = businessObjectService;
     }
 
     public CapitalAssetBuilderModuleService getCapitalAssetBuilderModuleService() {
         return capitalAssetBuilderModuleService;
     }
 
     public void setCapitalAssetBuilderModuleService(CapitalAssetBuilderModuleService capitalAssetBuilderModuleService) {
         this.capitalAssetBuilderModuleService = capitalAssetBuilderModuleService;
     }
 
     public PurchasingUnitOfMeasureValidation getUnitOfMeasureValidation() {
         return unitOfMeasureValidation;
     }
 
     public void setUnitOfMeasureValidation(PurchasingUnitOfMeasureValidation unitOfMeasureValidation) {
         this.unitOfMeasureValidation = unitOfMeasureValidation;
     }
 
     public PurchasingItemUnitPriceValidation getItemUnitPriceValidation() {
         return itemUnitPriceValidation;
     }
 
     public void setItemUnitPriceValidation(PurchasingItemUnitPriceValidation itemUnitPriceValidation) {
         this.itemUnitPriceValidation = itemUnitPriceValidation;
     }
 
     public PurchasingItemDescriptionValidation getItemDescriptionValidation() {
         return itemDescriptionValidation;
     }
 
     public void setItemDescriptionValidation(PurchasingItemDescriptionValidation itemDescriptionValidation) {
         this.itemDescriptionValidation = itemDescriptionValidation;
     }
 
     public PurchasingItemQuantityValidation getItemQuantityValidation() {
         return itemQuantityValidation;
     }
 
     public void setItemQuantityValidation(PurchasingItemQuantityValidation itemQuantityValidation) {
         this.itemQuantityValidation = itemQuantityValidation;
     }
 
     public PurchasingBelowTheLineItemNoUnitCostValidation getBelowTheLineItemNoUnitCostValidation() {
         return belowTheLineItemNoUnitCostValidation;
     }
 
     public void setBelowTheLineItemNoUnitCostValidation(PurchasingBelowTheLineItemNoUnitCostValidation belowTheLineItemNoUnitCostValidation) {
         this.belowTheLineItemNoUnitCostValidation = belowTheLineItemNoUnitCostValidation;
     }
 
 
 }