/*
    * Copyright 2006-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.sys.document.validation.impl;
  
  import java.util.Collection;
  import java.util.Collections;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.ole.sys.OLEKeyConstants;
  import org.kuali.ole.sys.OLEPropertyConstants;
  import org.kuali.ole.sys.businessobject.Bank;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.ole.sys.service.BankService;
  import org.kuali.rice.kns.document.MaintenanceDocument;
  import org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase;
  
  /**
   * Evaluates business rules for editing or creation of a new bank record.
   */
  public class BankRule extends MaintenanceDocumentRuleBase {
      protected Bank oldBank;
      protected Bank newBank;
  
      /**
       * @see org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase#processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)
       */
      protected boolean processCustomRouteDocumentBusinessRules(MaintenanceDocument document) {
          // default to success
          boolean valid = true;
  
          valid &= checkPartiallyFilledOutReferences();
          valid &= validateFieldsForBankOffsetEntries();
          valid &= validateBankAccountNumber();
  
          return valid;
      }
  
      /**
       * Sets the convenience objects like newAccount and oldAccount, so you have short and easy handles to the new and old objects
       * contained in the maintenance document. It also calls the BusinessObjectBase.refresh(), which will attempt to load all
       * sub-objects from the DB by their primary keys, if available.
       */
      public void setupConvenienceObjects() {
          oldBank = (Bank) super.getOldBo();
          newBank = (Bank) super.getNewBo();
      }
  
      /**
       * Checks for partially filled out objects.
       * 
       * @return true if there are no partially filled out references
       */
      protected boolean checkPartiallyFilledOutReferences() {
          boolean valid = true;
  
          valid &= checkForPartiallyFilledOutReferenceForeignKeys(OLEPropertyConstants.CASH_OFFSET_ACCOUNT);
          valid &= checkForPartiallyFilledOutReferenceForeignKeys(OLEPropertyConstants.CASH_OFFSET_OBJECT);
  
          return valid;
      }
  
      /**
       * Checks system parameter to determine if the bank code functionality is enabled. If so verifies the cash offset fields needed
       * to create the additional bank entries were given.
       * 
       * @return true if all cash offset fields needed have value
       */
      protected boolean validateFieldsForBankOffsetEntries() {
          boolean valid = true;
  
          if (SpringContext.getBean(BankService.class).isBankSpecificationEnabled()) {
  
              if (StringUtils.isBlank(newBank.getCashOffsetAccountNumber())) {
                  putFieldError(OLEPropertyConstants.CASH_OFFSET_ACCOUNT_NUMBER, OLEKeyConstants.Bank.ERROR_MISSING_CASH_ACCOUNT_NUMBER);
                  valid = false;
              }
      
              if (StringUtils.isBlank(newBank.getCashOffsetObjectCode())) {
                  putFieldError(OLEPropertyConstants.CASH_OFFSET_OBJECT_CODE, OLEKeyConstants.Bank.ERROR_MISSING_CASH_OBJECT_CODE);
                  valid = false;
              }
          }
  
          return valid;
      }
      
     /**
      * Bank account number must be unique.
      * 
      * @return
      */
     protected boolean validateBankAccountNumber() {
         // if the new bank is not blank *AND* has been changed
         // (I.e, never fire this edit if the account has not been changed)
         if ( StringUtils.isNotBlank(newBank.getBankAccountNumber() )
                 && (oldBank == null ||
                          !StringUtils.equals(oldBank.getBankAccountNumber(), newBank.getBankAccountNumber())) ) {
             @SuppressWarnings("rawtypes")
             Collection existingBanks = getBoService().findMatching(Bank.class, Collections.singletonMap(OLEPropertyConstants.BANK_ACCOUNT_NUMBER, newBank.getBankAccountNumber()));
             if ( existingBanks != null && !existingBanks.isEmpty() ) {
                 putFieldError(OLEPropertyConstants.BANK_ACCOUNT_NUMBER, OLEKeyConstants.Bank.ERROR_ACCOUNT_NUMBER_NOT_UNIQUE);
                 return false;
             }
         }
         return true;        
     }
 }