/*
    * 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.module.purap.businessobject;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.ole.integration.cab.CapitalAssetBuilderAssetTransactionType;
  import org.kuali.ole.module.purap.PurapPropertyConstants;
  import org.kuali.ole.module.purap.util.PurApItemUtils;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.rice.core.api.util.type.KualiDecimal;
  import org.kuali.rice.krad.service.KualiModuleService;
  import org.kuali.rice.krad.util.ObjectUtils;
  
  import java.math.BigDecimal;
  
  /**
   * Base class for Accounts Payable Item Business Objects.
   */
  public abstract class AccountsPayableItemBase extends PurApItemBase implements AccountsPayableItem {
      private KualiDecimal extendedPrice;
      private String capitalAssetTransactionTypeCode;
      private CapitalAssetBuilderAssetTransactionType capitalAssetTransactionType;
  
      /**
       * Method defaults to {@link #isConsideredEnteredWithZero()}
       *
       * @see org.kuali.module.purap.bo.PurchasingApItem#isConsideredEntered()
       */
      public boolean isConsideredEntered() {
          return isConsideredEnteredWithZero();
      }
  
      public boolean isEligibleDisplay() {
          return isConsideredEnteredWithZero();
      }
  
      public boolean isConsideredEnteredWithZero() {
          return isConsideredEntered(true);
      }
  
      public boolean isConsideredEnteredWithoutZero() {
          return isConsideredEntered(false);
      }
  
      /**
       * This method is used to determine whether an item has been entered that is we are satisfied there's enough info to continue
       * processing that particular item. It is currently used by the rules class to determine when it's necessary to run rules on
       * items (so that lines processors don't touch won't be validated) and to determine when to show items (in combination with the
       * full entry mode)
       *
       * @param allowsZero if this is true zero will be considered the same as null.
       * @return true if the item is considered entered false otherwise
       */
      private boolean isConsideredEntered(boolean allowsZero) {
          if (getItemType().isLineItemIndicator()) {
              if ((getItemType().isQuantityBasedGeneralLedgerIndicator())) {
                  if ((ObjectUtils.isNull(getItemQuantity())) && (ObjectUtils.isNull(getExtendedPrice()) || (allowsZero && getExtendedPrice().isZero()))) {
                      return false;
                  }
              } else {
                  if (ObjectUtils.isNull(getExtendedPrice()) || (allowsZero && getExtendedPrice().isZero())) {
                      return false;
                  }
              }
          } else {
              if ((ObjectUtils.isNull(getItemUnitPrice()) || (allowsZero && this.getItemUnitPrice().compareTo(new BigDecimal(0)) == 0)) && (StringUtils.isBlank(getItemDescription()))) {
                  return false;
              }
          }
  
          return true;
      }
  
      public boolean isNonZeroAmount() {
          return PurApItemUtils.isNonZeroExtended(this);
      }
  
      /**
       * Gets the extendedPrice attribute. this override is necessary because extended price needs to be set based on the unit price
       * for below the line(without this it would always be empty)
       *
       * @return Returns the extendedPrice.
       */
      @Override
      public KualiDecimal getExtendedPrice() {
          if (ObjectUtils.isNotNull(this.getItemUnitPrice()) && this.getItemType().isAmountBasedGeneralLedgerIndicator()) {
             if (ObjectUtils.isNotNull(this.getItemUnitPrice())) {
                 extendedPrice = new KualiDecimal(this.getItemUnitPrice().toString());
             } else {
                 extendedPrice = null;
             }
         } else if (ObjectUtils.isNull(this.getItemUnitPrice()) &&
                 this.getItemType().isAmountBasedGeneralLedgerIndicator() &&
                 this.getItemType().isAdditionalChargeIndicator()) { // This additional charges check is needed since non qty items also dont have unit price
             // extendedPrice should be null if the unit price is null
             extendedPrice = null;
         }
         return extendedPrice;
     }
 
     public void setExtendedPrice(KualiDecimal extendedPrice) {
         this.extendedPrice = extendedPrice;
     }
 
     /**
      * Override the method in PurApItemBase so that if the item is
      * not eligible to be displayed in the account summary tab,
      * which is if the item's extended price is null or zero,
      * we'll return null and the item won't be added
      * to the list of account summary.
      *
      * @see org.kuali.ole.module.purap.businessobject.PurApItemBase#getSummaryItem()
      */
     @Override
     public PurApSummaryItem getSummaryItem() {
         if (extendedPrice == null || extendedPrice.intValue() == 0) {
             return null;
         } else {
             return super.getSummaryItem();
         }
     }
 
     public String getCapitalAssetTransactionTypeCode() {
         return capitalAssetTransactionTypeCode;
     }
 
     public void setCapitalAssetTransactionTypeCode(String capitalAssetTransactionTypeCode) {
         this.capitalAssetTransactionTypeCode = capitalAssetTransactionTypeCode;
     }
 
     public CapitalAssetBuilderAssetTransactionType getCapitalAssetTransactionType() {
         return capitalAssetTransactionType = (CapitalAssetBuilderAssetTransactionType) SpringContext.getBean(KualiModuleService.class).getResponsibleModuleService(CapitalAssetBuilderAssetTransactionType.class).retrieveExternalizableBusinessObjectIfNecessary(this, capitalAssetTransactionType, PurapPropertyConstants.ITEM_CAPITAL_ASSET_TRANSACTION_TYPE);
     }
 
     public void setItemDescription(String itemDescription) {
         if ((itemDescription != null) && (itemDescription.length() > 100)) {
             super.setItemDescription(itemDescription.substring(0, 100));
         } else {
             super.setItemDescription(itemDescription);
         }
 
     }
 
 }