/*
    * Copyright 2007 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.pdp.document.validation.impl;
  
  import java.util.HashMap;
  import java.util.Map;
  
  import org.kuali.ole.pdp.PdpPropertyConstants;
  import org.kuali.ole.pdp.businessobject.PayeeACHAccount;
  import org.kuali.ole.sys.OLEKeyConstants;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.rice.kim.api.identity.Person;
  import org.kuali.rice.kns.document.MaintenanceDocument;
  import org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase;
  import org.kuali.rice.krad.service.BusinessObjectService;
  import org.kuali.rice.krad.util.GlobalVariables;
  
  /**
   * Performs business rules for the Payee ACH Account maintenance document
   */
  public class PayeeAchAccountRule extends MaintenanceDocumentRuleBase {
      protected static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(PayeeACHAccount.class);
  
      protected PayeeACHAccount oldPayeeAchAccount;
      protected PayeeACHAccount newPayeeAchAccount;
  
      /**
       * @see org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase#setupConvenienceObjects()
       */
      public void setupConvenienceObjects() {
          LOG.info("setupConvenienceObjects called");
  
          // setup oldPayeeAchAccount convenience objects, make sure all possible sub-objects are populated
          oldPayeeAchAccount = (PayeeACHAccount) super.getOldBo();
  
          // setup newPayeeAchAccount convenience objects, make sure all possible sub-objects are populated
          newPayeeAchAccount = (PayeeACHAccount) super.getNewBo();
      }
  
      /**
       * @see org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase#processCustomSaveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)
       */
      protected boolean processCustomSaveDocumentBusinessRules(MaintenanceDocument document) {
          LOG.info("processCustomSaveDocumentBusinessRules called");
  
          // call the route rules to report all of the messages, but ignore the result
          processCustomRouteDocumentBusinessRules(document);
  
          // Save always succeeds, even if there are business rule failures
          return true;
      }
  
      /**
       * @see org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase#processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)
       */
      protected boolean processCustomRouteDocumentBusinessRules(MaintenanceDocument document) {
          LOG.info("processCustomRouteDocumentBusinessRules called");
          setupConvenienceObjects();
  
          // no need to do further checking if user is not even allowed to submit new BO
          if (!checkTransactionTypeAllowed()) return false;
          
          return checkForDuplicateRecord();
      }
  
      /**
       * Checks to verify record is not a duplicate for payee id. Do not check for a duplicate record if the following conditions are
       * true 1. editing an existing record (old primary key = new primary key) 2. new PSD code = old PSD code 3. new payee type code
       * = old payee type code 4. depending of the value of payee type code, new correspoding PayeeId = old corresponding PayeeId
       * 
       * @return true if record is not duplicate, false otherwise
       */
      protected boolean checkForDuplicateRecord() {
          String newPayeeIdNumber = newPayeeAchAccount.getPayeeIdNumber();
          String newPayeeIdTypeCd = newPayeeAchAccount.getPayeeIdentifierTypeCode();
          String newAchTransactionType = newPayeeAchAccount.getAchTransactionType();
  
          boolean valid = true;
  
          if (newPayeeAchAccount.getAchAccountGeneratedIdentifier() != null && oldPayeeAchAccount.getAchAccountGeneratedIdentifier() != null && newPayeeAchAccount.getAchAccountGeneratedIdentifier().equals(oldPayeeAchAccount.getAchAccountGeneratedIdentifier())) {
              if (newPayeeIdTypeCd.equals(oldPayeeAchAccount.getPayeeIdentifierTypeCode()) && newAchTransactionType.equals(oldPayeeAchAccount.getAchTransactionType())) {
                  if (newPayeeAchAccount.getPayeeIdNumber().equals(oldPayeeAchAccount.getPayeeIdNumber())) {
                      return valid;
                  }
              }
          }
 
         // check for a duplicate record if creating a new record or editing an old one and above mentioned conditions are not true
         Map<String, Object> criteria = new HashMap<String, Object>();
 
         criteria.put(PdpPropertyConstants.ACH_TRANSACTION_TYPE, newAchTransactionType);
         criteria.put(PdpPropertyConstants.PAYEE_IDENTIFIER_TYPE_CODE, newPayeeIdTypeCd);
         criteria.put(PdpPropertyConstants.PAYEE_ID_NUMBER, newPayeeIdNumber);
 
         int matches = SpringContext.getBean(BusinessObjectService.class).countMatching(PayeeACHAccount.class, criteria);
         if (matches > 0) {
             putFieldError(PdpPropertyConstants.PAYEE_ID_NUMBER, OLEKeyConstants.ERROR_DOCUMENT_PAYEEACHACCOUNTMAINT_DUPLICATE_RECORD);
             valid = false;
         }
 
         return valid;
     }
 
     /**
      * Checks if the user is allowed to submit the new created/edited PayeeAchAccount based on its current transactionType.  
      * This checking is needed to prevent the following scenarios which bypass the document level authorization checking:
      * #1 A Bursar user creates a blank PayeeAchAccount, sets the transactionType to TR and submits;
      * #2 A Bursar user copies a PayeeAchAccount with transactionType BZ, changes the transactionType to TR and submits;
      * #3 A Bursar user edits a PayeeAchAccount with transactionType BZ, changes the transactionType to TR and submits.
      */
     protected boolean checkTransactionTypeAllowed() {
         String docTypeName = maintDocDictionaryService.getDocumentTypeName(PayeeACHAccount.class);
         Person user = GlobalVariables.getUserSession().getPerson();
         boolean allowed = businessObjectAuthorizationService.canMaintain(newPayeeAchAccount, user, docTypeName);
         String transType = newPayeeAchAccount.getAchTransactionType();
 
         if (!allowed) {
             putFieldError(PdpPropertyConstants.ACH_TRANSACTION_TYPE, OLEKeyConstants.ERROR_DOCUMENT_PAYEEACHACCOUNTMAINT_TRANSACTION_TYPE_NOT_ALLOWED, transType);
         }
         return allowed;
     }
     
 }