/*
    * 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.coa.document.validation.impl;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.ole.coa.businessobject.Account;
  import org.kuali.ole.coa.businessobject.IndirectCostRecoveryRateDetail;
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.rice.kns.document.MaintenanceDocument;
  import org.kuali.rice.krad.util.ObjectUtils;
  
  /**
   * PreRules checks for the {@link IndirectCostRecoveryRateDetail} that needs to occur while still in the Struts processing. This includes
   * defaults, confirmations, etc.
   */
  public class IndirectCostRecoveryRateDetailPreRules extends MaintenancePreRulesBase {
  
  
      protected IndirectCostRecoveryRateDetail indirectCostRecoveryRateDetail;
  
  
      public IndirectCostRecoveryRateDetailPreRules() {
  
      }
  
      /**
       * Executes the following pre rules
       * <ul>
       * <li>{@link IndirectCostRecoveryRateDetailPreRules#setSubAccountToDashesIfBlank()}</li>
       * <li>{@link IndirectCostRecoveryRateDetailPreRules#setSubObjectToDashesIfBlank()}</li>
       * </ul>
       * 
       * @see org.kuali.module.chart.rules.MaintenancePreRulesBase#doCustomPreRules(org.kuali.rice.kns.document.MaintenanceDocument)
       */
      protected boolean doCustomPreRules(MaintenanceDocument document) {
          setupConvenienceObjects(document);
          checkForContinuationAccounts(); // run this first to avoid side effects
  
          LOG.debug("done with continuation account, proceeeding with remaining pre rules");
  
          setSubAccountToDashesIfBlank();
          setSubObjectToDashesIfBlank();
  
          return true;
      }
  
      /**
       * This method checks for continuation accounts and presents the user with a question regarding their use on this account.
       */
      protected void checkForContinuationAccounts() {
          LOG.debug("entering checkForContinuationAccounts()");
  
          if (StringUtils.isNotBlank(indirectCostRecoveryRateDetail.getAccountNumber())) {
              Account account = checkForContinuationAccount("Account Number", indirectCostRecoveryRateDetail.getChartOfAccountsCode(), indirectCostRecoveryRateDetail.getAccountNumber(), "");
              if (ObjectUtils.isNotNull(account)) { // override old user inputs
                  indirectCostRecoveryRateDetail.setAccountNumber(account.getAccountNumber());
                  indirectCostRecoveryRateDetail.setChartOfAccountsCode(account.getChartOfAccountsCode());
              }
          }
      }
  
      /**
       * This sets the {@link SubAccount} number to padded dashes ("-") if blank
       */
      protected void setSubAccountToDashesIfBlank() {
          String newSubAccount = indirectCostRecoveryRateDetail.getSubAccountNumber();
          if (StringUtils.isBlank(newSubAccount)) {
              indirectCostRecoveryRateDetail.setSubAccountNumber(OLEConstants.getDashSubAccountNumber());
          }
      }
  
      /**
       * This sets the {@link org.kuali.module.chart.bo.SubObjCd} code to padded dashes ("-") if blank
       */
      protected void setSubObjectToDashesIfBlank() {
          String newSubObject = indirectCostRecoveryRateDetail.getFinancialSubObjectCode();
          if (StringUtils.isBlank(newSubObject)) {
              indirectCostRecoveryRateDetail.setFinancialSubObjectCode(OLEConstants.getDashFinancialSubObjectCode());
          }
      }
  
      /**
       * This method 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.
       */
     protected void setupConvenienceObjects(MaintenanceDocument document) {
 
         // setup newAccount convenience objects, make sure all possible sub-objects are populated
         indirectCostRecoveryRateDetail = (IndirectCostRecoveryRateDetail) document.getNewMaintainableObject().getBusinessObject();
     }
 }