/*
    * Copyright 2009 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.gl.businessobject;
  
  import java.util.LinkedHashMap;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.rice.core.api.util.type.KualiDecimal;
  import org.kuali.rice.krad.bo.TransientBusinessObjectBase;
  
  /**
   * An OriginEntryInformation wrapper which helpfully summarizes data for the pending entry report
   */
  public class PendingEntrySummary extends TransientBusinessObjectBase {
      private OriginEntryInformation originEntry;
      private boolean suppress;
      
      /**
       * @return the document number of the wrapped entry
       */
      public String getDocumentNumber() {
          return (!suppress) ? getConstantDocumentNumber() : "";
      }
      
      /**
       * @return the document number of the wrapped entry - even if suppressed
       */
      public String getConstantDocumentNumber() {
          return StringUtils.join(new String[] { originEntry.getFinancialSystemOriginationCode(),originEntry.getDocumentNumber()}, '-');
      }
      
      /**
       * @return the document type code of the wrapped entry
       */
      public String getDocumentTypeCode() {
          return (!suppress) ? getConstantDocumentTypeCode() : "";
      }
      
      /**
       * @return the document type code, even if suppressed
       */
      public String getConstantDocumentTypeCode() {
          return originEntry.getFinancialDocumentTypeCode();
      }
      
      /**
       * @return the balance type code of the wrapped entry
       */
      public String getBalanceTypeCode() {
          return (!suppress) ? getConstantBalanceTypeCode() : "";
      }
      
      /**
       * @return the balance type code, even if suppressed
       */
      public String getConstantBalanceTypeCode() {
          return originEntry.getFinancialBalanceTypeCode();
      }
      
      /**
       * @return the chart of accounts code of the wrapped entry
       */
      public String getChartOfAccountsCode() {
          return originEntry.getChartOfAccountsCode();
      }
      
      /**
       * @return the account number of the wrapped entry
       */
      public String getAccountNumber() {
          return originEntry.getAccountNumber();
      }
      
      /**
       * @return the financial object code of the wrapped entry
       */
      public String getFinancialObjectCode() {
          return originEntry.getFinancialObjectCode();
      }
      
      /**
       * @return the amount of the wrapped entry, or null if the entry does not represent a credit
       */
      public KualiDecimal getCreditAmount() {
          if (!StringUtils.isBlank(originEntry.getTransactionDebitCreditCode())) {
             if (originEntry.getTransactionDebitCreditCode().equals(OLEConstants.GL_CREDIT_CODE)) {
                 return originEntry.getTransactionLedgerEntryAmount(); 
             }
         }
         return null;
     }
 
     /**
      * @return the amount of the wrapped entry, or null if the entry does not represent a debit
      */
     public KualiDecimal getDebitAmount() {
         if (!StringUtils.isBlank(originEntry.getTransactionDebitCreditCode())) { 
             if (originEntry.getTransactionDebitCreditCode().equals(OLEConstants.GL_DEBIT_CODE)) {
                 return originEntry.getTransactionLedgerEntryAmount();
             }
         }
         return null;
     }
 
     /**
      * @return the amount for the wrapped entry, or null if the entry represents either a debit or a credt
      */
     public KualiDecimal getBudgetAmount() {
         return (originEntry.getTransactionDebitCreditCode() == null || originEntry.getTransactionDebitCreditCode().equals(OLEConstants.GL_BUDGET_CODE) || originEntry.getTransactionDebitCreditCode().equals(OLEConstants.EMPTY_STRING)) ? originEntry.getTransactionLedgerEntryAmount() : null;
     }
 
     /**
      * @see org.kuali.rice.krad.bo.BusinessObjectBase#toStringMapper()
      */
     
     protected LinkedHashMap toStringMapper_RICE20_REFACTORME() {
         LinkedHashMap<String, String> pkHashMap = new LinkedHashMap<String, String>();
         pkHashMap.put("documentTypeCode", this.getDocumentTypeCode());
         pkHashMap.put("documentNumber", this.getDocumentNumber());
         pkHashMap.put("chartOfAccountsCode", this.getChartOfAccountsCode());
         pkHashMap.put("accountNumber", this.getAccountNumber());
         pkHashMap.put("balanceTypeCode", this.getBalanceTypeCode());
         pkHashMap.put("financialObjectCode", this.getFinancialObjectCode());
         return pkHashMap;
     }
     
     /**
      * @param originEntry sets the origin entry
      */
     public void setOriginEntry(OriginEntryInformation originEntry) {
         this.originEntry = originEntry;
         this.suppress = false;
     }
 
     /**
      * Sets the suppress attribute value.
      * @param suppress The suppress to set.
      */
     public void suppressCommonFields(boolean suppress) {
         this.suppress = suppress;
     }
 
     /**
      * @return a String representation of suppressable fields
      */
     public String getSuppressableFieldsAsKey() {
         return StringUtils.join(new String[] {originEntry.getFinancialDocumentTypeCode(),originEntry.getFinancialSystemOriginationCode(),originEntry.getDocumentNumber(),originEntry.getFinancialBalanceTypeCode()}, ':');
     }
 }