/*
    * Copyright 2009 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.module.purap.PurapConstants;
  import org.kuali.ole.module.purap.PurapConstants.InvoiceStatuses;
  import org.kuali.ole.module.purap.PurapKeyConstants;
  import org.kuali.ole.module.purap.PurapParameterConstants;
  import org.kuali.ole.module.purap.businessobject.PurApAccountingLine;
  import org.kuali.ole.module.purap.businessobject.PurApItem;
  import org.kuali.ole.module.purap.document.InvoiceDocument;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.ole.sys.document.AccountingDocument;
  import org.kuali.ole.sys.document.validation.event.AttributedDocumentEvent;
  import org.kuali.ole.sys.service.impl.OleParameterConstants;
  import org.kuali.rice.coreservice.framework.parameter.ParameterService;
  import org.kuali.rice.krad.service.DataDictionaryService;
  import org.kuali.rice.krad.util.GlobalVariables;
  import org.kuali.rice.krad.util.ObjectUtils;
  
  public class InvoiceNonZeroAccountingLineAmountValidation extends PurchasingAccountsPayableAccountingLineAccessibleValidation {
  
      private PurApItem itemForValidation;
      private ParameterService parameterService;
  
      public boolean validate(AttributedDocumentEvent event) {
          boolean valid = true;
          String status = ((InvoiceDocument) event.getDocument()).getApplicationDocumentStatus();
  
          AccountingDocument accountingDocument = (AccountingDocument) event.getDocument();
          this.setAccountingDocumentForValidation(accountingDocument);
          this.setDataDictionaryService(SpringContext.getBean(DataDictionaryService.class));
  
          //Do this for AFOA only
          if (StringUtils.equals(InvoiceStatuses.APPDOC_AWAITING_FISCAL_REVIEW, status)) {
              for (PurApAccountingLine acct : itemForValidation.getSourceAccountingLines()) {
                  this.setAccountingLineForValidation(acct);
                  final boolean lineIsAccessible = lookupAccountingLineAuthorizer().hasEditPermissionOnAccountingLine(accountingDocument, acct, getAccountingLineCollectionProperty(), GlobalVariables.getUserSession().getPerson(), true);
                  // if the current logged in user has edit permissions on this line then validate the line..
                  if (lineIsAccessible) {
                      //if amount is null, throw an error.  If amount is zero, check system parameter and determine
                      //if the line can be approved.
                      if (ObjectUtils.isNull(acct.getAmount())) {
                          GlobalVariables.getMessageMap().putError(PurapConstants.ITEM_TAB_ERROR_PROPERTY, PurapKeyConstants.ERROR_ITEM_ACCOUNTING_AMOUNT_INVALID, itemForValidation.getItemIdentifierString());
                          valid &= false;
                      } else {
                          if (acct.getAmount().isZero()) {
                              if (!canApproveAccountingLinesWithZeroAmount()) {
                                  GlobalVariables.getMessageMap().putError(PurapConstants.ITEM_TAB_ERROR_PROPERTY, PurapKeyConstants.ERROR_ITEM_ACCOUNTING_AMOUNT_INVALID, itemForValidation.getItemIdentifierString());
                                  valid &= false;
                              }
                          }
                      }
                  }
              }
          }
  
          return valid;
      }
  
      /**
       * checks if an accounting line with zero dollar amount can be approved.  This will check
       * the system parameter APPROVE_ACCOUNTING_LINES_WITH_ZERO_DOLLAR_AMOUNT_IND and determines if the
       * line can be approved or not.
       *
       * @return true if the system parameter value is Y else returns N.
       */
      public boolean canApproveAccountingLinesWithZeroAmount() {
          boolean canApproveLine = false;
  
          // get parameter to see if accounting line with zero dollar amount can be approved.
          String approveZeroAmountLine = SpringContext.getBean(ParameterService.class).getParameterValueAsString(OleParameterConstants.PURCHASING_DOCUMENT.class, PurapParameterConstants.APPROVE_ACCOUNTING_LINES_WITH_ZERO_DOLLAR_AMOUNT_IND);
  
          if ("Y".equalsIgnoreCase(approveZeroAmountLine)) {
              return true;
          }
  
          return canApproveLine;
      }
  
      public PurApItem getItemForValidation() {
          return itemForValidation;
      }
  
      public void setItemForValidation(PurApItem itemForValidation) {
         this.itemForValidation = itemForValidation;
     }
 
     /**
      * Gets the parameterService attribute.
      *
      * @return Returns the parameterService
      */
 
     public ParameterService getParameterService() {
         return parameterService;
     }
 
     /**
      * Sets the parameterService attribute.
      *
      * @param parameterService The parameterService to set.
      */
     public void setParameterService(ParameterService parameterService) {
         this.parameterService = parameterService;
     }
 }