/**
    * Copyright 2004-2012 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.kfs.coa.businessobject;
  
  import java.sql.Date;
  import java.util.Calendar;
  import java.util.LinkedHashMap;
  import java.util.List;
  
  import org.apache.commons.lang.StringUtils;
  import org.apache.commons.lang.time.DateUtils;
  import org.kuali.rice.core.api.mo.common.active.Inactivatable;
  import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
  
  /**
   * 
   */
  public class Account extends PersistableBusinessObjectBase implements Inactivatable {
      protected static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(Account.class);
  
      private String chartOfAccountsCode;
      private String accountNumber;
      private String accountName;
      private Date accountCreateDate;
      private Date accountEffectiveDate;
      private Date accountExpirationDate;
      private boolean active;
      private String organizationCode;
      //private boolean closed;
  
      public String getOrganizationCode() {
  		return organizationCode;
  	}
  
  	public void setOrganizationCode(String organizationCode) {
  		this.organizationCode = organizationCode;
  	}
  
  
  	private Chart chartOfAccounts;
      private Organization organization;
  
      private List subAccounts;
  
      /**
       * Default no-arg constructor.
       */
      public Account() {
          active = true; // assume active is true until set otherwise
      }
      
  
      /**
       * Gets the accountNumber attribute.
       * 
       * @return Returns the accountNumber
       */
      public String getAccountNumber() {
          return accountNumber;
      }
  
      /**
       * Sets the accountNumber attribute.
       * 
       * @param accountNumber The accountNumber to set.
       */
      public void setAccountNumber(String accountNumber) {
          this.accountNumber = accountNumber;
      }
  
      /**
       * Gets the accountName attribute.
       * 
       * @return Returns the accountName
       */
      public String getAccountName() {
          return accountName;
      }
  
      /**
       * Sets the accountName attribute.
       * 
       * @param accountName The accountName to set.
       */
      public void setAccountName(String accountName) {
          this.accountName = accountName;
     }
 
     /**
      * Gets the accountCreateDate attribute.
      * 
      * @return Returns the accountCreateDate
      */
     public Date getAccountCreateDate() {
         return accountCreateDate;
     }
 
     /**
      * Sets the accountCreateDate attribute.
      * 
      * @param accountCreateDate The accountCreateDate to set.
      */
     public void setAccountCreateDate(Date accountCreateDate) {
         this.accountCreateDate = accountCreateDate;
     }
 
     /**
      * Gets the accountEffectiveDate attribute.
      * 
      * @return Returns the accountEffectiveDate
      */
     public Date getAccountEffectiveDate() {
         return accountEffectiveDate;
     }
 
     /**
      * Sets the accountEffectiveDate attribute.
      * 
      * @param accountEffectiveDate The accountEffectiveDate to set.
      */
     public void setAccountEffectiveDate(Date accountEffectiveDate) {
         this.accountEffectiveDate = accountEffectiveDate;
     }
 
     /**
      * Gets the accountExpirationDate attribute.
      * 
      * @return Returns the accountExpirationDate
      */
     public Date getAccountExpirationDate() {
         return accountExpirationDate;
     }
 
     /**
      * Sets the accountExpirationDate attribute.
      * 
      * @param accountExpirationDate The accountExpirationDate to set.
      */
     public void setAccountExpirationDate(Date accountExpirationDate) {
         this.accountExpirationDate = accountExpirationDate;
     }
 
     /**
      * This method determines whether the account is expired or not. Note that if Expiration Date is the same date as testDate, then
      * this will return false. It will only return true if the account expiration date is one day earlier than testDate or earlier.
      * Note that this logic ignores all time components when doing the comparison. It only does the before/after comparison based on
      * date values, not time-values.
      * 
      * @param testDate - Calendar instance with the date to test the Account's Expiration Date against. This is most commonly set to
      *        today's date.
      * @return true or false based on the logic outlined above
      */
     public boolean isExpired(Calendar testDate) {
         if (LOG.isDebugEnabled()) {
             LOG.debug("entering isExpired(" + testDate + ")");
         }
 
         // dont even bother trying to test if the accountExpirationDate is null
         if (this.accountExpirationDate == null) {
             return false;
         }
 
         // remove any time-components from the testDate
         testDate = DateUtils.truncate(testDate, Calendar.DAY_OF_MONTH);
 
         // get a calendar reference to the Account Expiration
         // date, and remove any time components
         Calendar acctDate = Calendar.getInstance();
         acctDate.setTime(this.accountExpirationDate);
         acctDate = DateUtils.truncate(acctDate, Calendar.DAY_OF_MONTH);
 
         // if the Account Expiration Date is before the testDate
         if (acctDate.before(testDate)) {
             return true;
         }
         else {
             return false;
         }
     }
 
     /**
      * This method determines whether the account is expired or not. Note that if Expiration Date is the same date as testDate, then
      * this will return false. It will only return true if the account expiration date is one day earlier than testDate or earlier.
      * Note that this logic ignores all time components when doing the comparison. It only does the before/after comparison based on
      * date values, not time-values.
      * 
      * @param testDate - java.util.Date instance with the date to test the Account's Expiration Date against. This is most commonly
      *        set to today's date.
      * @return true or false based on the logic outlined above
      */
     public boolean isExpired(Date testDate) {
 
         // dont even bother trying to test if the accountExpirationDate is null
         if (this.accountExpirationDate == null) {
             return false;
         }
 
         Calendar acctDate = Calendar.getInstance();
         acctDate.setTime(testDate);
         return isExpired(acctDate);
     }
 
     /**
      * Gets the active attribute.
      * 
      * @return Returns the active
      */
     public boolean isActive() {
         return active;
     }
 
     /**
      * Sets the active attribute.
      * 
      * @param active The active to set.
      */
     public void setActive(boolean active) {
         this.active = active;
     }
 
     /**
      * Returns whether this account is not active or not
      * 
      * @return the opposite of isActive()
      */
     public boolean isClosed() {
         return !active;
     }
     
     /**
      * Sets the closed attribute.
      * 
      * @param closed The closed to set.
      */
     public void setClosed(boolean closed) {
         this.active = !closed;
     }
 
     /**
      * Gets the chartOfAccounts attribute.
      * 
      * @return Returns the chartOfAccounts
      */
     public Chart getChartOfAccounts() {
         return chartOfAccounts;
     }
 
     /**
      * Sets the chartOfAccounts attribute.
      * 
      * @param chartOfAccounts The chartOfAccounts to set.
      * @deprecated
      */
     public void setChartOfAccounts(Chart chartOfAccounts) {
         this.chartOfAccounts = chartOfAccounts;
     }
 
     /**
      * Gets the organization attribute.
      * 
      * @return Returns the organization
      */
     public Organization getOrganization() {
         return organization;
     }
 
     /**
      * Sets the organization attribute.
      * 
      * @param organization The organization to set.
      * @deprecated
      */
     public void setOrganization(Organization organization) {
         this.organization = organization;
     }
 
     /**
      * @return Returns the subAccounts.
      */
     public List getSubAccounts() {
         return subAccounts;
     }
 
 
     /**
      * @param subAccounts The subAccounts to set.
      */
     public void setSubAccounts(List subAccounts) {
         this.subAccounts = subAccounts;
     }
 
 
     /**
      * @return Returns the chartOfAccountsCode.
      */
     public String getChartOfAccountsCode() {
         return chartOfAccountsCode;
     }
 
 
     /**
      * @param chartOfAccountsCode The chartOfAccountsCode to set.
      */
     public void setChartOfAccountsCode(String chartOfAccountsCode) {
         this.chartOfAccountsCode = chartOfAccountsCode;
     }
 
     /**
      * @see org.kuali.rice.kns.bo.BusinessObjectBase#toStringMapper()
      */
     protected LinkedHashMap toStringMapper() {
         LinkedHashMap m = new LinkedHashMap();
 
         m.put("chartCode", this.chartOfAccountsCode);
         m.put("accountNumber", this.accountNumber);
 
         return m;
     }
 
 
     /**
      * Implementing equals since I need contains to behave reasonably in a hashed datastructure.
      * 
      * @see java.lang.Object#equals(java.lang.Object)
      */
     public boolean equals(Object obj) {
         boolean equal = false;
 
         if (obj != null) {
             if (this.getClass().equals(obj.getClass())) {
                 Account other = (Account) obj;
 
                 if (StringUtils.equals(this.getChartOfAccountsCode(), other.getChartOfAccountsCode())) {
                     if (StringUtils.equals(this.getAccountNumber(), other.getAccountNumber())) {
                         equal = true;
                     }
                 }
             }
         }
 
         return equal;
     }
 
     /**
      * Calcluates hashCode based on current values of chartOfAccountsCode and accountNumber fields. Somewhat dangerous, since both
      * of those fields are mutable, but I don't expect people to be editing those values directly for Accounts stored in hashed
      * datastructures.
      * 
      * @see java.lang.Object#hashCode()
      */
     public int hashCode() {
         String hashString = getChartOfAccountsCode() + "|" + getAccountNumber();
 
         return hashString.hashCode();
     }
 
 
     /**
      * Convenience method to make the primitive account fields from this Account easier to compare to the account fields from
      * another Account or an AccountingLine
      * 
      * @return String representing the account associated with this Accounting
      */
     public String getAccountKey() {
         String key = getChartOfAccountsCode() + ":" + getAccountNumber();
         return key;
     }
 }