/*
    * 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.fp.businessobject;
  
  import java.sql.Date;
  import java.util.ArrayList;
  import java.util.LinkedHashMap;
  import java.util.List;
  
  import org.kuali.ole.fp.document.CashManagementDocument;
  import org.kuali.ole.fp.document.CashReceiptDocument;
  import org.kuali.ole.sys.OLEPropertyConstants;
  import org.kuali.ole.sys.businessobject.Bank;
  import org.kuali.rice.core.api.util.type.KualiDecimal;
  import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
  
  
  /**
   * This class represents a deposit used in the cash management document
   */
  public class Deposit extends PersistableBusinessObjectBase {
      // primary key
      private String documentNumber;
      private Integer financialDocumentDepositLineNumber;
      // attributes
      private String depositTypeCode;
      private Date depositDate;
      private KualiDecimal depositAmount;
      private String depositTicketNumber;
      // related objects and foreign keys
      private String depositBankCode;
  
      private CurrencyDetail depositedCurrency;
      private CoinDetail depositedCoin;
  
      private Bank bank;
      private CashManagementDocument cashManagementDocument;
      private List depositCashReceiptControl;
  
  
      /**
       * Default constructor.
       */
      public Deposit() {
          depositCashReceiptControl = new ArrayList();
          bank = new Bank();
      }
  
      /**
       * Gets the bank attribute. 
       * @return Returns the bank.
       */
      public Bank getBank() {
          return bank;
      }
  
      /**
       * Sets the bank attribute value.
       * @param bank The bank to set.
       */
      public void setBank(Bank bank) {
          this.bank = bank;
      }
  
      /**
       * @return current value of cashManagementDocument.
       */
      public CashManagementDocument getCashManagementDocument() {
          return cashManagementDocument;
      }
  
      /**
       * Sets the cashManagementDocument attribute value.
       * 
       * @param cashManagementDocument The cashManagementDocument to set.
       */
      public void setCashManagementDocument(CashManagementDocument cashManagementDocument) {
          this.cashManagementDocument = cashManagementDocument;
      }
  
  
      /**
       * @return current value of depositCashReceiptControl.
       */
      public List getDepositCashReceiptControl() {
         return depositCashReceiptControl;
     }
 
     /**
      * Sets the depositCashReceiptControl attribute value.
      * 
      * @param depositCashReceiptControl The depositCashReceiptControl to set.
      */
     public void setDepositCashReceiptControl(List depositCashReceiptControl) {
         this.depositCashReceiptControl = depositCashReceiptControl;
     }
 
     /**
      * @return current value of depositAmount.
      */
     public KualiDecimal getDepositAmount() {
         return depositAmount;
     }
 
     /**
      * Sets the depositAmount attribute value.
      * 
      * @param depositAmount The depositAmount to set.
      */
     public void setDepositAmount(KualiDecimal depositAmount) {
         this.depositAmount = depositAmount;
     }
 
 
     /**
      * @return current value of depositBankCode.
      */
     public String getDepositBankCode() {
         return depositBankCode;
     }
 
     /**
      * Sets the depositBankCode attribute value.
      * 
      * @param depositBankCode The depositBankCode to set.
      */
     public void setDepositBankCode(String depositBankCode) {
         this.depositBankCode = depositBankCode;
     }
 
 
     /**
      * @return current value of depositDate.
      */
     public Date getDepositDate() {
         return depositDate;
     }
 
     /**
      * Sets the depositDate attribute value.
      * 
      * @param depositDate The depositDate to set.
      */
     public void setDepositDate(Date depositDate) {
         this.depositDate = depositDate;
     }
 
 
     /**
      * @return current value of depositTicketNumber.
      */
     public String getDepositTicketNumber() {
         return depositTicketNumber;
     }
 
     /**
      * Sets the depositTicketNumber attribute value.
      * 
      * @param depositTicketNumber The depositTicketNumber to set.
      */
     public void setDepositTicketNumber(String depositTicketNumber) {
         this.depositTicketNumber = depositTicketNumber;
     }
 
     /**
      * @return current value of depositTypeCode, under a different name, to prevent the POJO code from reformatting it
      */
     public String getRawDepositTypeCode() {
         return depositTypeCode;
     }
 
     /**
      * @return current value of depositTypeCode.
      */
     public String getDepositTypeCode() {
         return depositTypeCode;
     }
 
     /**
      * Sets the depositTypeCode attribute value.
      * 
      * @param depositTypeCode The depositTypeCode to set.
      */
     public void setDepositTypeCode(String depositTypeCode) {
         this.depositTypeCode = depositTypeCode;
     }
 
 
     /**
      * @return current value of financialDocumentDepositLineNumber.
      */
     public Integer getFinancialDocumentDepositLineNumber() {
         return financialDocumentDepositLineNumber;
     }
 
     /**
      * Sets the financialDocumentDepositLineNumber attribute value.
      * 
      * @param financialDocumentDepositLineNumber The financialDocumentDepositLineNumber to set.
      */
     public void setFinancialDocumentDepositLineNumber(Integer financialDocumentDepositLineNumber) {
         this.financialDocumentDepositLineNumber = financialDocumentDepositLineNumber;
     }
 
 
     /**
      * @return current value of 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;
     }
 
 
     /**
      * @see org.kuali.rice.krad.bo.BusinessObjectBase#toStringMapper()
      */
     
     protected LinkedHashMap toStringMapper_RICE20_REFACTORME() {
         LinkedHashMap m = new LinkedHashMap();
         m.put(OLEPropertyConstants.DOCUMENT_NUMBER, getDocumentNumber());
         m.put("financialDocumentDepositLineNumber", getFinancialDocumentDepositLineNumber());
         return m;
     }
 
 
     /**
      * Returns true if this deposit has the same document deposit line number as the passed in Deposit
      * 
      * @param other
      * @return true if the given Deposit has primary key values equal to this Deposit
      */
     public boolean keysEqual(Deposit other) {
         boolean keysEqual = false;
 
         if (getDocumentNumber().equals(other.getDocumentNumber())) {
             if (getFinancialDocumentDepositLineNumber().equals(other.getFinancialDocumentDepositLineNumber())) {
                 keysEqual = true;
             }
         }
 
         return keysEqual;
     }
 
     /**
      * This method returns whether the given deposit contains the parameter cash receipt document
      * 
      * @param crDoc the cash receipt document to look for
      * @return true if the cash receipt document is part of the deposit, false if otherwise
      */
     public boolean containsCashReceipt(CashReceiptDocument crDoc) {
         boolean result = false;
         for (int i = 0; i < this.getDepositCashReceiptControl().size() && !result; i++) {
             DepositCashReceiptControl crCtrl = (DepositCashReceiptControl) getDepositCashReceiptControl().get(i);
             result = crCtrl.getFinancialDocumentCashReceiptNumber().equals(crDoc.getDocumentNumber());
         }
         return result;
     }
 
     /**
      * Gets the depositedCoin attribute.
      * 
      * @return Returns the depositedCoin.
      */
     public CoinDetail getDepositedCoin() {
         return depositedCoin;
     }
 
 
     /**
      * Sets the depositedCoin attribute value.
      * 
      * @param depositedCoin The depositedCoin to set.
      */
     public void setDepositedCoin(CoinDetail depositedCoin) {
         this.depositedCoin = depositedCoin;
     }
 
 
     /**
      * Gets the depositedCurrency attribute.
      * 
      * @return Returns the depositedCurrency.
      */
     public CurrencyDetail getDepositedCurrency() {
         return depositedCurrency;
     }
 
 
     /**
      * Sets the depositedCurrency attribute value.
      * 
      * @param depositedCurrency The depositedCurrency to set.
      */
     public void setDepositedCurrency(CurrencyDetail depositedCurrency) {
         this.depositedCurrency = depositedCurrency;
     }
 }