/*
    * 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.module.cg.businessobject;
  
  import java.util.LinkedHashMap;
  
  import org.kuali.ole.coa.businessobject.Account;
  import org.kuali.ole.coa.businessobject.Chart;
  import org.kuali.ole.integration.cg.ContractsAndGrantsAccountAwardInformation;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.rice.core.api.mo.common.active.MutableInactivatable;
  import org.kuali.rice.kim.api.identity.Person;
  import org.kuali.rice.kim.api.identity.PersonService;
  import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
  import org.kuali.rice.krad.util.ObjectUtils;
  
  /**
   * This class represents an association between an award and an account. It's like a reference to the account from the award. This
   * way an award can maintain a collection of these references instead of owning accounts directly.
   */
  public class AwardAccount extends PersistableBusinessObjectBase implements CGProjectDirector, MutableInactivatable, ContractsAndGrantsAccountAwardInformation {
      private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(AwardAccount.class);
      
      protected Long proposalNumber;
      protected String chartOfAccountsCode;
      protected String accountNumber;
      protected String principalId;
      protected boolean active = true;
  
      protected Account account;
      protected Chart chartOfAccounts;
      protected Person projectDirector;
      protected Award award;
  
      /**
       * Default constructor.
       */
      public AwardAccount() {
          // Struts needs this instance to populate the secondary key, principalName.
          if ( SpringContext.isInitialized() ) {
              try {
                  projectDirector = (Person)SpringContext.getBean(PersonService.class).getPersonImplementationClass().newInstance();
              }
              catch (Exception ex) {
                  LOG.error( "Unable to create a template person object.", ex );
              }
          }
      }
  
      /***
       * @see org.kuali.ole.integration.businessobject.cg.ContractsAndGrantsAccountAwardInformation#getProposalNumber()
       */
      public Long getProposalNumber() {
          return proposalNumber;
      }
  
      /**
       * Sets the proposalNumber attribute.
       * 
       * @param proposalNumber The proposalNumber to set.
       */
      public void setProposalNumber(Long proposalNumber) {
          this.proposalNumber = proposalNumber;
      }
  
  
      /***
       * @see org.kuali.ole.integration.businessobject.cg.ContractsAndGrantsAccountAwardInformation#getChartOfAccountsCode()
       */
      public String getChartOfAccountsCode() {
          return chartOfAccountsCode;
      }
  
      /**
       * Sets the chartOfAccountsCode attribute.
       * 
       * @param chartOfAccountsCode The chartOfAccountsCode to set.
       */
      public void setChartOfAccountsCode(String chartOfAccountsCode) {
          this.chartOfAccountsCode = chartOfAccountsCode;
      }
  
  
      /***
       * @see org.kuali.ole.integration.businessobject.cg.ContractsAndGrantsAccountAwardInformation#getAccountNumber()
      */
     public String getAccountNumber() {
         return accountNumber;
     }
 
     /**
      * Sets the accountNumber attribute.
      * 
      * @param accountNumber The accountNumber to set.
      */
     public void setAccountNumber(String accountNumber) {
         this.accountNumber = accountNumber;
     }
 
     /***
      * @see org.kuali.ole.integration.businessobject.cg.ContractsAndGrantsAccountAwardInformation#getPrincipalId()
      */
     public String getPrincipalId() {
         return principalId;
     }
 
     /**
      * Sets the principalId attribute.
      * 
      * @param principalId The principalId to set.
      */
     public void setPrincipalId(String principalId) {
         this.principalId = principalId;
     }
 
     /***
      * @see org.kuali.ole.integration.businessobject.cg.ContractsAndGrantsAccountAwardInformation#getAccount()
      */
     public Account getAccount() {
         return account;
     }
 
     /**
      * Sets the account attribute.
      * 
      * @param account The account to set.
      * @deprecated Setter is required by OJB, but should not be used to modify this attribute. This attribute is set on the initial
      *             creation of the object and should not be changed.
      */
     @Deprecated
     public void setAccount(Account account) {
         this.account = account;
     }
 
     /***
      * @see org.kuali.ole.integration.businessobject.cg.ContractsAndGrantsAccountAwardInformation#getChartOfAccounts()
      */
     public Chart getChartOfAccounts() {
         return chartOfAccounts;
     }
 
     /**
      * Sets the chartOfAccounts attribute.
      * 
      * @param chartOfAccounts The chartOfAccounts to set.
      * @deprecated Setter is required by OJB, but should not be used to modify this attribute. This attribute is set on the initial
      *             creation of the object and should not be changed.
      */
     @Deprecated
     public void setChartOfAccounts(Chart chartOfAccounts) {
         this.chartOfAccounts = chartOfAccounts;
     }
 
     /***
      * @see org.kuali.ole.integration.businessobject.cg.ContractsAndGrantsAccountAwardInformation#getProjectDirector()
      */
     public Person getProjectDirector() {
         projectDirector = SpringContext.getBean(org.kuali.rice.kim.api.identity.PersonService.class).updatePersonIfNecessary(principalId, projectDirector);
         return projectDirector;
     }
 
     /**
      * Sets the project director attribute
      * 
      * @param projectDirector The projectDirector to set.
      * @deprecated Setter is required by OJB, but should not be used to modify this attribute. This attribute is set on the initial
      *             creation of the object and should not be changed.
      */
     @Deprecated
     public void setProjectDirector(Person projectDirector) {
         this.projectDirector = projectDirector;
     }
 
     /**
      * @see org.kuali.rice.krad.bo.BusinessObjectBase#toStringMapper()
      */
     @SuppressWarnings("unchecked")
     
     protected LinkedHashMap toStringMapper_RICE20_REFACTORME() {
         LinkedHashMap m = new LinkedHashMap();
         if (this.proposalNumber != null) {
             m.put("proposalNumber", this.proposalNumber.toString());
         }
         m.put("chartOfAccountsCode", this.chartOfAccountsCode);
         m.put("accountNumber", this.accountNumber);
         return m;
     }
 
     /***
      * @see org.kuali.ole.integration.businessobject.cg.ContractsAndGrantsAccountAwardInformation#getAward()
      */
     public Award getAward() {
         return award;
     }
 
     /**
      * This method sets the associated award to the value provided.
      * 
      * @param award Value to be assigned to the associated Award object.
      */
     public void setAward(Award award) {
         this.award = award;
     }
 
     /**
      * @see org.kuali.rice.core.api.mo.common.active.MutableInactivatable#isActive()
      */
     public boolean isActive() {
         return active;
     }
 
     /**
      * @see org.kuali.rice.core.api.mo.common.active.MutableInactivatable#setActive(boolean)
      */
     public void setActive(boolean active) {
         this.active = active;
     }
 
     /**
      * @see org.kuali.ole.integration.cg.ContractsAndGrantsAccountAwardInformation#getProjectDirectorName()
      */
     public String getProjectDirectorName() {
         if (!ObjectUtils.isNull(projectDirector)) {
             return projectDirector.getName();
         }
         return null;
     }
 }