/*
    * 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.coa.businessobject;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.HashMap;
  import java.util.LinkedHashMap;
  import java.util.List;
  import java.util.Map;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.ole.coa.service.OrganizationReversionService;
  import org.kuali.ole.sys.OLEPropertyConstants;
  import org.kuali.ole.sys.businessobject.SystemOptions;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.rice.krad.bo.GlobalBusinessObject;
  import org.kuali.rice.krad.bo.GlobalBusinessObjectDetail;
  import org.kuali.rice.krad.bo.PersistableBusinessObject;
  import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
  import org.kuali.rice.krad.service.BusinessObjectService;
  import org.kuali.rice.krad.service.PersistenceStructureService;
  
  /**
   * The representation of a Global Organization Reversion. A Global Organization Reversion is made up of three sections: 1. The
   * University Fiscal Year and Chart of Accounts code for the Organizations going through reversion, with some account information.
   * 2. A list of the appropriate Object Reversion Details 3. A list of Organizations to apply the Organization Reversion to
   */
  public class OrganizationReversionGlobal extends PersistableBusinessObjectBase implements GlobalBusinessObject {
      private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(OrganizationReversionGlobal.class);
      protected String documentNumber;
  
      protected Integer universityFiscalYear;
      protected String budgetReversionChartOfAccountsCode;
      protected String budgetReversionAccountNumber;
      protected Boolean carryForwardByObjectCodeIndicator;
      protected String cashReversionFinancialChartOfAccountsCode;
      protected String cashReversionAccountNumber;
  
      protected Account cashReversionAccount;
      protected Account budgetReversionAccount;
      protected Chart budgetReversionChartOfAccounts;
      protected Chart cashReversionFinancialChartOfAccounts;
      protected SystemOptions universityFiscal;
  
      protected List<OrganizationReversionGlobalDetail> organizationReversionGlobalDetails;
      protected List<OrganizationReversionGlobalOrganization> organizationReversionGlobalOrganizations;
  
      public OrganizationReversionGlobal() {
          super();
          organizationReversionGlobalDetails = new ArrayList<OrganizationReversionGlobalDetail>();
          organizationReversionGlobalOrganizations = new ArrayList<OrganizationReversionGlobalOrganization>();
      }
  
      /**
       * @see org.kuali.rice.krad.bo.BusinessObjectBase#toStringMapper()
       */
      
      protected LinkedHashMap toStringMapper_RICE20_REFACTORME() {
          LinkedHashMap stringMapper = new LinkedHashMap();
          stringMapper.put(OLEPropertyConstants.DOCUMENT_NUMBER, this.documentNumber);
          stringMapper.put(OLEPropertyConstants.UNIVERSITY_FISCAL_YEAR, this.universityFiscalYear);
          return stringMapper;
      }
  
      /**
       * Gets the budgetReversionAccount attribute.
       * 
       * @return Returns the budgetReversionAccount.
       */
      public Account getBudgetReversionAccount() {
          return budgetReversionAccount;
      }
  
      /**
       * Gets the documentNumber attribute.
       * 
       * @return Returns the documentNumber.
       */
      public String getDocumentNumber() {
          return documentNumber;
      }
  
      /**
       * Sets the documentNumber attribute value.
       * 
      * @param documentNumber The documentNumber to set.
      */
     public void setDocumentNumber(String documentNumber) {
         this.documentNumber = documentNumber;
     }
 
     /**
      * Sets the budgetReversionAccount attribute value.
      * 
      * @param budgetReversionAccount The budgetReversionAccount to set.
      * @deprecated
      */
     public void setBudgetReversionAccount(Account budgetReversionAccount) {
         this.budgetReversionAccount = budgetReversionAccount;
     }
 
     /**
      * Gets the budgetReversionAccountNumber attribute.
      * 
      * @return Returns the budgetReversionAccountNumber.
      */
     public String getBudgetReversionAccountNumber() {
         return budgetReversionAccountNumber;
     }
 
     /**
      * Sets the budgetReversionAccountNumber attribute value.
      * 
      * @param budgetReversionAccountNumber The budgetReversionAccountNumber to set.
      */
     public void setBudgetReversionAccountNumber(String budgetReversionAccountNumber) {
         this.budgetReversionAccountNumber = budgetReversionAccountNumber;
     }
 
     /**
      * Gets the budgetReversionChartOfAccounts attribute.
      * 
      * @return Returns the budgetReversionChartOfAccounts.
      */
     public Chart getBudgetReversionChartOfAccounts() {
         return budgetReversionChartOfAccounts;
     }
 
     /**
      * Sets the budgetReversionChartOfAccounts attribute value.
      * 
      * @param budgetReversionChartOfAccounts The budgetReversionChartOfAccounts to set.
      * @deprecated
      */
     public void setBudgetReversionChartOfAccounts(Chart budgetReversionChartOfAccounts) {
         this.budgetReversionChartOfAccounts = budgetReversionChartOfAccounts;
     }
 
     /**
      * Gets the budgetReversionChartOfAccountsCode attribute.
      * 
      * @return Returns the budgetReversionChartOfAccountsCode.
      */
     public String getBudgetReversionChartOfAccountsCode() {
         return budgetReversionChartOfAccountsCode;
     }
 
     /**
      * Sets the budgetReversionChartOfAccountsCode attribute value.
      * 
      * @param budgetReversionChartOfAccountsCode The budgetReversionChartOfAccountsCode to set.
      */
     public void setBudgetReversionChartOfAccountsCode(String budgetReversionChartOfAccountsCode) {
         this.budgetReversionChartOfAccountsCode = budgetReversionChartOfAccountsCode;
     }
 
     /**
      * Gets the carryForwardByObjectCodeIndicator attribute.
      * 
      * @return Returns the carryForwardByObjectCodeIndicator.
      */
     public Boolean isCarryForwardByObjectCodeIndicator() {
         return carryForwardByObjectCodeIndicator;
     }
 
     /**
      * Gets the carryForwardByObjectCodeIndicator attribute: but for other methods that don't like to call "is" and would rather
      * call "get"
      * 
      * @return Returns the carryForwardByObjectCodeIndicator.
      */
     public Boolean getCarryForwardByObjectCodeIndicator() {
         return this.isCarryForwardByObjectCodeIndicator();
     }
 
     /**
      * Sets the carryForwardByObjectCodeIndicator attribute value.
      * 
      * @param carryForwardByObjectCodeIndicator The carryForwardByObjectCodeIndicator to set.
      */
     public void setCarryForwardByObjectCodeIndicator(Boolean carryForwardByObjectCodeIndicator) {
         this.carryForwardByObjectCodeIndicator = carryForwardByObjectCodeIndicator;
     }
 
     /**
      * Gets the cashReversionAccount attribute.
      * 
      * @return Returns the cashReversionAccount.
      */
     public Account getCashReversionAccount() {
         return cashReversionAccount;
     }
 
     /**
      * Sets the cashReversionAccount attribute value.
      * 
      * @param cashReversionAccount The cashReversionAccount to set.
      * @deprecated
      */
     public void setCashReversionAccount(Account cashReversionAccount) {
         this.cashReversionAccount = cashReversionAccount;
     }
 
     /**
      * Gets the cashReversionAccountNumber attribute.
      * 
      * @return Returns the cashReversionAccountNumber.
      */
     public String getCashReversionAccountNumber() {
         return cashReversionAccountNumber;
     }
 
     /**
      * Sets the cashReversionAccountNumber attribute value.
      * 
      * @param cashReversionAccountNumber The cashReversionAccountNumber to set.
      */
     public void setCashReversionAccountNumber(String cashReversionAccountNumber) {
         this.cashReversionAccountNumber = cashReversionAccountNumber;
     }
 
     /**
      * Gets the cashReversionFinancialChartOfAccounts attribute.
      * 
      * @return Returns the cashReversionFinancialChartOfAccounts.
      */
     public Chart getCashReversionFinancialChartOfAccounts() {
         return cashReversionFinancialChartOfAccounts;
     }
 
     /**
      * Sets the cashReversionFinancialChartOfAccounts attribute value.
      * 
      * @param cashReversionFinancialChartOfAccounts The cashReversionFinancialChartOfAccounts to set.
      * @deprecated
      */
     public void setCashReversionFinancialChartOfAccounts(Chart cashReversionFinancialChartOfAccounts) {
         this.cashReversionFinancialChartOfAccounts = cashReversionFinancialChartOfAccounts;
     }
 
     /**
      * Gets the cashReversionFinancialChartOfAccountsCode attribute.
      * 
      * @return Returns the cashReversionFinancialChartOfAccountsCode.
      */
     public String getCashReversionFinancialChartOfAccountsCode() {
         return cashReversionFinancialChartOfAccountsCode;
     }
 
     /**
      * Sets the cashReversionFinancialChartOfAccountsCode attribute value.
      * 
      * @param cashReversionFinancialChartOfAccountsCode The cashReversionFinancialChartOfAccountsCode to set.
      */
     public void setCashReversionFinancialChartOfAccountsCode(String cashReversionFinancialChartOfAccountsCode) {
         this.cashReversionFinancialChartOfAccountsCode = cashReversionFinancialChartOfAccountsCode;
     }
 
     /**
      * Gets the organizationReversionGlobalOrganizations attribute.
      * 
      * @return Returns the organizationReversionGlobalOrganizations.
      */
     public List<OrganizationReversionGlobalOrganization> getOrganizationReversionGlobalOrganizations() {
         return organizationReversionGlobalOrganizations;
     }
 
     /**
      * Sets the organizationReversionGlobalOrganizations attribute value.
      * 
      * @param organizationReversionGlobalOrganizations The organizationReversionGlobalOrganizations to set.
      * @deprecated
      */
     public void setOrganizationReversionGlobalOrganizations(List<OrganizationReversionGlobalOrganization> organizationReversionGlobalOrganizations) {
         this.organizationReversionGlobalOrganizations = organizationReversionGlobalOrganizations;
     }
 
     /**
      * Gets the organizationReversionGlobalDocumentDetails attribute.
      * 
      * @return Returns the organizationReversionGlobalDocumentDetails.
      */
     public List<OrganizationReversionGlobalDetail> getOrganizationReversionGlobalDetails() {
         return organizationReversionGlobalDetails;
     }
 
     /**
      * Sets the organizationReversionGlobalDocumentDetails attribute value.
      * 
      * @param organizationReversionGlobalDocumentDetails The organizationReversionGlobalDocumentDetails to set.
      */
     public void setOrganizationReversionGlobalDetails(List<OrganizationReversionGlobalDetail> organizationReversionGlobalDetails) {
         this.organizationReversionGlobalDetails = organizationReversionGlobalDetails;
     }
 
     /**
      * Gets the universityFiscalYear attribute.
      * 
      * @return Returns the universityFiscalYear.
      */
     public Integer getUniversityFiscalYear() {
         return universityFiscalYear;
     }
 
     /**
      * Sets the universityFiscalYear attribute value.
      * 
      * @param universityFiscalYear The universityFiscalYear to set.
      */
     public void setUniversityFiscalYear(Integer universityFiscalYear) {
         this.universityFiscalYear = universityFiscalYear;
     }
 
     /**
      * Gets the universityFiscal attribute.
      * 
      * @return Returns the universityFiscal.
      */
     public SystemOptions getUniversityFiscal() {
         return universityFiscal;
     }
 
     /**
      * Sets the universityFiscal attribute value.
      * 
      * @param universityFiscal The universityFiscal to set.
      */
     public void setUniversityFiscal(SystemOptions universityFiscal) {
         this.universityFiscal = universityFiscal;
     }
 
     /**
      * @see org.kuali.rice.krad.bo.GlobalBusinessObject#generateDeactivationsToPersist() As global organization reversions only update
      *      existing records, deactivations will never be produced by creating one; thus, this method always returns an empty list.
      */
     public List<PersistableBusinessObject> generateDeactivationsToPersist() {
         return null;
     }
 
     /**
      * @see org.kuali.rice.krad.bo.GlobalBusinessObject#generateGlobalChangesToPersist() This creates a list of changes to be made to the
      *      existing Organization Reversion records impacted by this global reversion.
      */
     public List<PersistableBusinessObject> generateGlobalChangesToPersist() {
         List<PersistableBusinessObject> persistingChanges = new ArrayList<PersistableBusinessObject>();
 
         BusinessObjectService boService = SpringContext.getBean(BusinessObjectService.class);
         Map<String, OrganizationReversionGlobalDetail> detailsMap = this.rearrangeOrganizationReversionDetailsAsMap();
 
         for (OrganizationReversionGlobalOrganization orgRevOrg : this.getOrganizationReversionGlobalOrganizations()) {
             // 1. find that organization reversion
             OrganizationReversion currOrgRev = SpringContext.getBean(OrganizationReversionService.class).getByPrimaryId(this.getUniversityFiscalYear(), orgRevOrg.getChartOfAccountsCode(), orgRevOrg.getOrganizationCode());
 
             if (currOrgRev != null) { // only proceed if there's a pre-existing org reversion; we don't want to insert any new
                                         // records
                 if (!StringUtils.isBlank(this.getBudgetReversionChartOfAccountsCode())) {
                     currOrgRev.setBudgetReversionChartOfAccountsCode(this.getBudgetReversionChartOfAccountsCode());
                 }
                 if (!StringUtils.isBlank(this.getBudgetReversionAccountNumber())) {
                     currOrgRev.setBudgetReversionAccountNumber(this.getBudgetReversionAccountNumber());
                 }
                 if (!StringUtils.isBlank(this.getCashReversionFinancialChartOfAccountsCode())) {
                     currOrgRev.setCashReversionFinancialChartOfAccountsCode(this.getCashReversionFinancialChartOfAccountsCode());
                 }
                 if (!StringUtils.isBlank(this.getCashReversionAccountNumber())) {
                     currOrgRev.setCashReversionAccountNumber(this.getCashReversionAccountNumber());
                 }
 
                 if (this.isCarryForwardByObjectCodeIndicator() != null) {
                     currOrgRev.setCarryForwardByObjectCodeIndicator(this.isCarryForwardByObjectCodeIndicator().booleanValue());
                 }
 
                 // 3. now, go through each org reversion detail and update each of those
                 for (OrganizationReversionDetail orgRevDetail : currOrgRev.getOrganizationReversionDetail()) {
                     OrganizationReversionGlobalDetail changeDetail = detailsMap.get(orgRevDetail.getOrganizationReversionCategoryCode());
                     if (changeDetail != null) {
                         if (!StringUtils.isBlank(changeDetail.getOrganizationReversionCode())) {
                             orgRevDetail.setOrganizationReversionCode(changeDetail.getOrganizationReversionCode());
                         }
                         if (!StringUtils.isBlank(changeDetail.getOrganizationReversionObjectCode())) {
                             orgRevDetail.setOrganizationReversionObjectCode(changeDetail.getOrganizationReversionObjectCode());
                         }
                     }
                 }
 
                 currOrgRev.refreshNonUpdateableReferences();
                 persistingChanges.add(currOrgRev);
             }
 
         }
         return persistingChanges;
     }
 
     /**
      * This sticks all of the Organization Reversion Change Details into a map, for quicker access in
      * generateGlobalChangesToPersist.
      * 
      * @return a map of all organization reversion change details, keyed by OrganizationReversionCategory
      */
     protected Map<String, OrganizationReversionGlobalDetail> rearrangeOrganizationReversionDetailsAsMap() {
         Map<String, OrganizationReversionGlobalDetail> orgRevMap = new HashMap<String, OrganizationReversionGlobalDetail>();
         for (OrganizationReversionGlobalDetail orgRevDetail : this.getOrganizationReversionGlobalDetails()) {
             if (!StringUtils.isBlank(orgRevDetail.getOrganizationReversionObjectCode()) || !StringUtils.isBlank(orgRevDetail.getOrganizationReversionCode())) {
                 orgRevMap.put(orgRevDetail.getOrganizationReversionCategoryCode(), orgRevDetail);
             }
         }
         return orgRevMap;
     }
 
     /**
      * @see org.kuali.rice.krad.bo.GlobalBusinessObject#getAllDetailObjects() This returns a list of all the detail objects held within
      *      this main global organization reversion container.
      */
     public List<? extends GlobalBusinessObjectDetail> getAllDetailObjects() {
         List<GlobalBusinessObjectDetail> detailObjects = new ArrayList<GlobalBusinessObjectDetail>();
         detailObjects.addAll(this.getOrganizationReversionGlobalDetails());
         detailObjects.addAll(this.getOrganizationReversionGlobalOrganizations());
         return detailObjects;
     }
 
     /**
      * @see org.kuali.rice.krad.bo.GlobalBusinessObject#isPersistable() returns whether this global object reversion can be stored in the
      *      database, which is really a question of whether it and all of its details have all of their appropriate primary keys
      *      set.
      */
     public boolean isPersistable() {
         PersistenceStructureService persistenceStructureService = SpringContext.getBean(PersistenceStructureService.class);
 
         if (!persistenceStructureService.hasPrimaryKeyFieldValues(this)) {
             return false;
         }
 
         for (OrganizationReversionGlobalDetail orgRevDetail : this.getOrganizationReversionGlobalDetails()) {
             if (!persistenceStructureService.hasPrimaryKeyFieldValues(orgRevDetail)) {
                 return false;
             }
         }
 
         for (OrganizationReversionGlobalOrganization orgRevOrg : this.getOrganizationReversionGlobalOrganizations()) {
             if (!persistenceStructureService.hasPrimaryKeyFieldValues(orgRevOrg)) {
                 return false;
             }
         }
 
         // are we still here? really? Then, hey, let's persist!
         return true;
     }
 
     /**
      * @see org.kuali.rice.krad.bo.PersistableBusinessObjectBase#buildListOfDeletionAwareLists()
      */
     @Override
     public List buildListOfDeletionAwareLists() {
         List<Collection<PersistableBusinessObject>> managedLists = super.buildListOfDeletionAwareLists();
 
         managedLists.add( new ArrayList<PersistableBusinessObject>( getOrganizationReversionGlobalDetails() ) );
         managedLists.add( new ArrayList<PersistableBusinessObject>( getOrganizationReversionGlobalOrganizations() ) );
 
         return managedLists;
     }
 }