/*
    * Copyright 2006 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.coa.document.validation.impl;
  
  import java.util.List;
  
  import org.kuali.ole.coa.businessobject.OrganizationReversion;
  import org.kuali.ole.coa.businessobject.OrganizationReversionDetail;
  import org.kuali.ole.sys.OLEKeyConstants;
  import org.kuali.rice.kns.document.MaintenanceDocument;
  import org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase;
  import org.kuali.rice.krad.util.GlobalVariables;
  import org.kuali.rice.krad.util.ObjectUtils;
  
  /**
   * This class implements the business rules specific to the {@link OrganizationReversion} Maintenance Document.
   */
  public class OrganizationReversionRule extends MaintenanceDocumentRuleBase {
  
      protected static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(OrganizationReversionRule.class);
  
      protected OrganizationReversion oldOrgReversion;
      protected OrganizationReversion newOrgReversion;
  
      /**
       * No-Args Constructor for an OrganizationReversionRule.
       */
      public OrganizationReversionRule() {
  
      }
  
      /**
       * This performs rules checks on document route
       * <ul>
       * <li>{@link OrganizationReversionRule#validateDetailBusinessObjects(OrganizationReversion)}</li>
       * </ul>
       * This rule fails on business rule failures
       * @see org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase#processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)
       */
      @Override
      protected boolean processCustomRouteDocumentBusinessRules(MaintenanceDocument document) {
  
          boolean success = true;
  
          // make sure its a valid organization reversion MaintenanceDocument
          if (!isCorrectMaintenanceClass(document, OrganizationReversion.class)) {
              throw new IllegalArgumentException("Maintenance Document passed in was of the incorrect type.  Expected " + "'" + OrganizationReversion.class.toString() + "', received " + "'" + document.getOldMaintainableObject().getBoClass().toString() + "'.");
          }
  
          // get the real business object
          newOrgReversion = (OrganizationReversion) document.getNewMaintainableObject().getBusinessObject();
  
          // add check to validate document recursively to get to the collection attributes
          success &= validateDetailBusinessObjects(newOrgReversion);
  
          return success;
      }
  
      /**
       * Tests each option attached to the main business object and validates its properties.
       * 
       * @param orgReversion
       * @return false if any of the detail objects fail with their validation
       */
      protected boolean validateDetailBusinessObjects(OrganizationReversion orgReversion) {
          GlobalVariables.getMessageMap().addToErrorPath("document.newMaintainableObject");
          List<OrganizationReversionDetail> details = orgReversion.getOrganizationReversionDetail();
          int index = 0;
          int originalErrorCount = GlobalVariables.getMessageMap().getErrorCount();
          for (OrganizationReversionDetail dtl : details) {
              String errorPath = "organizationReversionDetail[" + index + "]";
              GlobalVariables.getMessageMap().addToErrorPath(errorPath);
              validateOrganizationReversionDetail(dtl);
              validateOrganizationReversionCode(orgReversion, dtl);
              GlobalVariables.getMessageMap().removeFromErrorPath(errorPath);
              index++;
          }
          GlobalVariables.getMessageMap().removeFromErrorPath("document.newMaintainableObject");
          return GlobalVariables.getMessageMap().getErrorCount() == originalErrorCount;
      }
      
      /**
       * 
       * This checks to make sure that the organization reversion object on the detail object actually exists
       * @param detail
       * @return false if the organization reversion object doesn't exist
      */
     protected boolean validateOrganizationReversionDetail(OrganizationReversionDetail detail) {
         
         // let's assume this detail will pass the rule
         boolean result = true;
         
         // 1. makes sure the financial object code exists
         detail.refreshReferenceObject("organizationReversionObject");
         if (ObjectUtils.isNull(detail.getOrganizationReversionObject())) {
             LOG.debug("organization reversion finanical object = null");
             result = false;
             GlobalVariables.getMessageMap().putError("organizationReversionObjectCode", OLEKeyConstants.ERROR_EXISTENCE, new String[] { "Financial Object Code: " + detail.getOrganizationReversionObjectCode() });
         } else {
             if (LOG.isDebugEnabled()) {
                 LOG.debug("organization reversion finanical object = " + detail.getOrganizationReversionObject().getName());            
             }
         }
         return result;
     }
 
     /**
      * 
      * Verifies that a reversion code exists when the 
      * "Carry Forward by Object Code" indicator is selected.  If this indicator
      * isn't selected, then the reversion codes isn't required.
      * 
      * @param reversion OrganizationReversion object
      * @param detail OrganizationReversionDetail object
      * 
      * @return true for successful validation
      */
     protected boolean validateOrganizationReversionCode(OrganizationReversion reversion, OrganizationReversionDetail detail) {
         
         //
         // Assume it will pass!
         //
         boolean result = true;
         
         //
         // Only need to verify that organization reversion code exists if the
         // "Carry Forward by Object Code Indicator" is not selected.
         //
         if (reversion.isCarryForwardByObjectCodeIndicator()) {
             if (ObjectUtils.isNull(detail.getOrganizationReversionCode())) {
                 result = false;
                 GlobalVariables.getMessageMap().putError("organizationReversionCode", OLEKeyConstants.ERROR_DOCUMENT_GLOBAL_ORG_REVERSION_NO_REVERSION_CODE);
             }
         }
         return result;
     }
 }