/*
    * Copyright 2008-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.module.purap.businessobject;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.ole.module.purap.document.AccountsPayableDocumentBase;
  import org.kuali.ole.module.purap.document.LineItemReceivingDocument;
  import org.kuali.ole.module.purap.document.PurchaseOrderDocument;
  import org.kuali.ole.module.purap.exception.PurError;
  import org.kuali.rice.core.api.util.type.KualiDecimal;
  import org.kuali.rice.krad.util.ObjectUtils;
  
  import java.util.List;
  
  /**
   * @author Kuali Nervous System Team (kualidev@oncourse.iu.edu)
   */
  public class LineItemReceivingItem extends ReceivingItemBase {
  
      private KualiDecimal itemOrderedQuantity;
  
      // not stored in db
      private KualiDecimal itemReceivedPriorQuantity;
      private KualiDecimal itemReceivedToBeQuantity;
  
      private LineItemReceivingDocument lineItemReceivingDocument;
  
      private static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(AccountsPayableDocumentBase.class);
  
      /**
       * Default constructor.
       */
      public LineItemReceivingItem() {
      }
  
      public LineItemReceivingItem(LineItemReceivingDocument rld) {
          this.setDocumentNumber(rld.getDocumentNumber());
          this.setItemReceivedTotalQuantity(KualiDecimal.ZERO);
          this.setItemReturnedTotalQuantity(KualiDecimal.ZERO);
          this.setItemDamagedTotalQuantity(KualiDecimal.ZERO);
          this.setItemOriginalReceivedTotalQuantity(KualiDecimal.ZERO);
          this.setItemOriginalReturnedTotalQuantity(KualiDecimal.ZERO);
          this.setItemOriginalDamagedTotalQuantity(KualiDecimal.ZERO);
      }
  
      public LineItemReceivingItem(PurchaseOrderItem poi, LineItemReceivingDocument rld) {
  
          this.setDocumentNumber(rld.getDocumentNumber());
          this.setItemTypeCode(poi.getItemTypeCode());
          this.setPurchaseOrderIdentifier(rld.getPurchaseOrderIdentifier());
  
          this.setItemLineNumber(poi.getItemLineNumber());
          this.setItemCatalogNumber(poi.getItemCatalogNumber());
          this.setItemDescription(poi.getItemDescription());
  
          this.setItemOrderedQuantity(poi.getItemQuantity());
          this.setItemUnitOfMeasureCode(poi.getItemUnitOfMeasureCode());
  
          // TODO: Chris - look into this it appears this is null rather than zero on amendment, find out why!
          if (ObjectUtils.isNull(poi.getItemReceivedTotalQuantity())) {
              this.setItemReceivedPriorQuantity(KualiDecimal.ZERO);
          } else {
              this.setItemReceivedPriorQuantity(poi.getItemReceivedTotalQuantity());
          }
  
          this.setItemReceivedToBeQuantity(this.getItemOrderedQuantity().subtract(this.getItemReceivedPriorQuantity()));
  
          // should determine whether this is prefilled be based on the parameter that allows loading from po
          this.setItemReceivedTotalQuantity(KualiDecimal.ZERO);
  
          this.setItemReturnedTotalQuantity(KualiDecimal.ZERO);
          this.setItemDamagedTotalQuantity(KualiDecimal.ZERO);
  
          this.setItemOriginalReceivedTotalQuantity(KualiDecimal.ZERO);
          this.setItemOriginalReturnedTotalQuantity(KualiDecimal.ZERO);
          this.setItemOriginalDamagedTotalQuantity(KualiDecimal.ZERO);
  
          // not added
          this.setItemReasonAddedCode(null);
      }
  
      /**
       * Retreives a purchase order item by inspecting the item type to see if its above the line or below the line and returns the
       * appropriate type.
       *
       * @return - purchase order item
      */
     public PurchaseOrderItem getPurchaseOrderItem() {
         if (ObjectUtils.isNotNull(this.getLineItemReceivingDocument())) {
             if (ObjectUtils.isNull(this.getLineItemReceivingDocument())) {
                 this.refreshReferenceObject("lineItemReceivingDocument");
             }
         }
         // ideally we should do this a different way - maybe move it all into the service or save this info somehow (make sure and
         // update though)
         if (getLineItemReceivingDocument() != null) {
             PurchaseOrderDocument po = getLineItemReceivingDocument().getPurchaseOrderDocument();
             PurchaseOrderItem poi = null;
             if (this.getItemType().isLineItemIndicator()) {
                 List<PurchaseOrderItem> items = po.getItems();
                 poi = items.get(this.getItemLineNumber().intValue() - 1);
 
                 // throw error if line numbers don't match
             }
             if (poi != null) {
                 return poi;
             } else {
                 // LOG.debug("getPurchaseOrderItem() Returning null because PurchaseOrderItem object for line number" +
                 // getItemLineNumber() + "or itemType " + getItemTypeCode() + " is null");
                 return null;
             }
         } else {
             LOG.error("getPurchaseOrderItem() Returning null because paymentRequest object is null");
             throw new PurError("Receiving Line Object in Purchase Order item line number " + getItemLineNumber() + "or itemType " + getItemTypeCode() + " is null");
         }
     }
 
     /**
      * Gets the itemOrderedQuantity attribute.
      *
      * @return Returns the itemOrderedQuantity
      */
     public KualiDecimal getItemOrderedQuantity() {
         return itemOrderedQuantity;
     }
 
     /**
      * Sets the itemOrderedQuantity attribute.
      *
      * @param itemOrderedQuantity The itemOrderedQuantity to set.
      */
     public void setItemOrderedQuantity(KualiDecimal itemOrderedQuantity) {
         this.itemOrderedQuantity = itemOrderedQuantity;
     }
 
     /**
      * Gets the LineItemReceivingDocument attribute.
      *
      * @return Returns the LineItemReceivingDocument.
      */
     public LineItemReceivingDocument getLineItemReceivingDocument() {
         return lineItemReceivingDocument;
     }
 
     /**
      * Sets the LineItemReceivingDocument attribute value.
      *
      * @param LineItemReceivingDocument The LineItemReceivingDocument to set.
      * @deprecated
      */
     public void setLineItemReceivingDocument(LineItemReceivingDocument lineItemReceivingDocument) {
         this.lineItemReceivingDocument = lineItemReceivingDocument;
     }
 
     public KualiDecimal getItemReceivedPriorQuantity() {
         if (ObjectUtils.isNull(itemReceivedPriorQuantity)) {
             setItemReceivedPriorQuantity(getPurchaseOrderItem().getItemReceivedTotalQuantity());
         }
         return itemReceivedPriorQuantity;
     }
 
     public void setItemReceivedPriorQuantity(KualiDecimal itemReceivedPriorQuantity) {
 
         this.itemReceivedPriorQuantity = itemReceivedPriorQuantity;
     }
 
     public KualiDecimal getItemReceivedToBeQuantity() {
         // lazy loaded
         KualiDecimal toBeQuantity = this.getItemOrderedQuantity().subtract(getItemReceivedPriorQuantity());
         if (toBeQuantity.isNegative()) {
             toBeQuantity = KualiDecimal.ZERO;
         }
         setItemReceivedToBeQuantity(toBeQuantity);
 
         return itemReceivedToBeQuantity;
     }
 
     public void setItemReceivedToBeQuantity(KualiDecimal itemReceivedToBeQuantity) {
         this.itemReceivedToBeQuantity = itemReceivedToBeQuantity;
     }
 
     public boolean isOrderedItem() {
         return StringUtils.isEmpty(getItemReasonAddedCode());
     }
 
 }