/*
    * 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.kuali.ole.module.purap.document.service.PurchaseOrderService;
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.rice.krad.bo.Note;
  import org.kuali.rice.krad.document.Document;
  import org.kuali.rice.krad.util.ObjectUtils;
  
  import java.sql.Timestamp;
  import java.util.ArrayList;
  import java.util.List;
  
  /**
   * Purchase Order View Business Object.
   */
  public class PurchaseOrderView extends AbstractRelatedView {
  
      private Boolean purchaseOrderCurrentIndicator;
      private String recurringPaymentTypeCode;
      private String vendorChoiceCode;
      private Timestamp recurringPaymentEndDate;
      private Timestamp purchaseOrderInitialOpenTimestamp;
  
      private List<Note> notes;
  
      public boolean isPurchaseOrderCurrentIndicator() {
          return purchaseOrderCurrentIndicator;
      }
  
      public boolean getPurchaseOrderCurrentIndicator() {
          return purchaseOrderCurrentIndicator;
      }
  
      public void setPurchaseOrderCurrentIndicator(boolean purchaseOrderCurrentIndicator) {
          this.purchaseOrderCurrentIndicator = purchaseOrderCurrentIndicator;
      }
  
      public String getRecurringPaymentTypeCode() {
          return recurringPaymentTypeCode;
      }
  
      public void setRecurringPaymentTypeCode(String recurringPaymentTypeCode) {
          this.recurringPaymentTypeCode = recurringPaymentTypeCode;
      }
  
      public String getVendorChoiceCode() {
          return vendorChoiceCode;
      }
  
      public void setVendorChoiceCode(String vendorChoiceCode) {
          this.vendorChoiceCode = vendorChoiceCode;
      }
  
      public Timestamp getRecurringPaymentEndDate() {
          return recurringPaymentEndDate;
      }
  
      public void setRecurringPaymentEndDate(Timestamp recurringPaymentEndDate) {
          this.recurringPaymentEndDate = recurringPaymentEndDate;
      }
  
      public Timestamp getPurchaseOrderInitialOpenTimestamp() {
          return purchaseOrderInitialOpenTimestamp;
      }
  
      public void setPurchaseOrderInitialOpenTimestamp(Timestamp purchaseOrderInitialOpenTimestamp) {
          this.purchaseOrderInitialOpenTimestamp = purchaseOrderInitialOpenTimestamp;
      }
  
      /**
       * @see org.kuali.ole.module.purap.businessobject.AbstractRelatedView#getNotes()
       */
      @Override
      public List<Note> getNotes() {
          if (this.isPurchaseOrderCurrentIndicator()) {
              if (notes == null) {
                  notes = new ArrayList<Note>();
                  List<Note> tmpNotes = SpringContext.getBean(PurchaseOrderService.class).getPurchaseOrderNotes(this.getPurapDocumentIdentifier());
                  //FIXME if NoteService returns notes in descending order (newer ones first) then remove the following
                  // reverse the order of notes retrieved so that newest note is in the front
                  for (int i = tmpNotes.size() - 1; i >= 0; i--) {
                      Note note = tmpNotes.get(i);
                      notes.add(note);
                 }
             }
         } else {
             notes = null;
         }
         return notes;
     }
 
     /**
      * The next four methods are overridden but shouldn't be! If they aren't overridden, they don't show up in the tag, not sure why at
      * this point! (AAP)
      *
      * @see org.kuali.ole.module.purap.businessobject.AbstractRelatedView#getPurapDocumentIdentifier()
      */
     @Override
     public Integer getPurapDocumentIdentifier() {
         return super.getPurapDocumentIdentifier();
     }
 
     @Override
     public String getDocumentIdentifierString() {
         return super.getDocumentIdentifierString();
     }
 
     /**
      * @see org.kuali.ole.module.purap.businessobject.AbstractRelatedView#getDocumentNumber()
      */
     @Override
     public String getDocumentNumber() {
         return super.getDocumentNumber();
     }
 
     /**
      * @see org.kuali.ole.module.purap.businessobject.AbstractRelatedView#getUrl()
      */
     @Override
     public String getUrl() {
         return super.getUrl();
     }
 
     /**
      * Checks whether the purchase order view needs a warning to be displayed, i.e. it never has been opened.
      *
      * @return true if the purchase order needs a warning; false otherwise.
      */
     public boolean getNeedWarning() {
         return getPurchaseOrderInitialOpenTimestamp() == null;
     }
 
     /**
      * @see org.kuali.ole.module.purap.businessobject.AbstractRelatedView#getDocumentTypeName()
      */
     @Override
     public String getDocumentTypeName() {
         Document document = findDocument(this.getDocumentNumber());
         if (ObjectUtils.isNotNull(document)) {
             return document.getDocumentHeader().getWorkflowDocument().getDocumentTypeName();
         }
 
         return OLEConstants.FinancialDocumentTypeCodes.PURCHASE_ORDER;
     }
 }