/*
    * Copyright 2008 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.sys.businessobject;
  
  import java.sql.Date;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.rice.core.api.util.type.KualiDecimal;
  import org.kuali.rice.kew.api.WorkflowDocument;
  import org.kuali.rice.kew.api.exception.WorkflowException;
  import org.kuali.rice.krad.bo.DocumentHeader;
  import org.kuali.rice.krad.util.GlobalVariables;
  import org.kuali.rice.krad.workflow.service.WorkflowDocumentService;
  
  /**
   * This class is a custom {@link DocumentHeader} class used by OLE to facilitate custom data fields and a few UI fields
   */
  public class FinancialSystemDocumentHeader extends DocumentHeader {
  
      protected KualiDecimal financialDocumentTotalAmount;
      protected String correctedByDocumentId;
      protected String financialDocumentInErrorNumber;
      protected String financialDocumentStatusCode;
  
      /**
       * Constructor - creates empty instances of dependent objects
       *
       */
      public FinancialSystemDocumentHeader() {
          super();
          financialDocumentStatusCode = OLEConstants.DocumentStatusCodes.INITIATED;
      }
  
      /**
       * Gets the financialDocumentTotalAmount attribute.
       * @return Returns the financialDocumentTotalAmount.
       */
      public KualiDecimal getFinancialDocumentTotalAmount() {
          return financialDocumentTotalAmount;
      }
  
      /**
       * Sets the financialDocumentTotalAmount attribute value.
       * @param financialDocumentTotalAmount The financialDocumentTotalAmount to set.
       */
      public void setFinancialDocumentTotalAmount(KualiDecimal financialDocumentTotalAmount) {
          this.financialDocumentTotalAmount = financialDocumentTotalAmount;
      }
  
      /**
       * Gets the correctedByDocumentId attribute.
       * @return Returns the correctedByDocumentId.
       */
      public String getCorrectedByDocumentId() {
          return correctedByDocumentId;
      }
  
      /**
       * Sets the correctedByDocumentId attribute value.
       * @param correctedByDocumentId The correctedByDocumentId to set.
       */
      public void setCorrectedByDocumentId(String correctedByDocumentId) {
          this.correctedByDocumentId = correctedByDocumentId;
      }
  
      /**
       * Gets the financialDocumentInErrorNumber attribute.
       * @return Returns the financialDocumentInErrorNumber.
       */
      public String getFinancialDocumentInErrorNumber() {
          return financialDocumentInErrorNumber;
      }
  
      /**
       * Sets the financialDocumentInErrorNumber attribute value.
       * @param financialDocumentInErrorNumber The financialDocumentInErrorNumber to set.
       */
      public void setFinancialDocumentInErrorNumber(String financialDocumentInErrorNumber) {
          this.financialDocumentInErrorNumber = financialDocumentInErrorNumber;
      }
  
      /**
       * Gets the financialDocumentStatusCode attribute.
       * @return Returns the financialDocumentStatusCode.
      */
     public String getFinancialDocumentStatusCode() {
         return financialDocumentStatusCode;
     }
 
     /**
      * Sets the financialDocumentStatusCode attribute value.
      * @param financialDocumentStatusCode The financialDocumentStatusCode to set.
      */
     public void setFinancialDocumentStatusCode(String financialDocumentStatusCode) {
         this.financialDocumentStatusCode = financialDocumentStatusCode;
     }
 
     /**
      * Gets the documentFinalDate attribute.
      * @return Returns the documentFinalDate.
      */
     public Date getDocumentFinalDate() {
         WorkflowDocument workflowDoc = this.getWorkflowDocument();
         if (workflowDoc == null || (workflowDoc.getDateFinalized() == null)) {
             return null;
         }
         return  new java.sql.Date(workflowDoc.getDateFinalized().getMillis());
     }
 
     /**
      * Gets the applicationDocumentStatus attribute.
      *
      * @return Returns the applicationDocumentStatus
      */
 
     public String getApplicationDocumentStatus() {
         WorkflowDocument document = getWorkflowDocument();
         return StringUtils.trimToEmpty(document.getApplicationDocumentStatus());
     }
 
     /**
      * Sets the applicationDocumentStatus attribute.
      *
      * @param applicationDocumentStatus The applicationDocumentStatus to set.
      */
     public void setApplicationDocumentStatus(String applicationDocumentStatus) {
         WorkflowDocument document = getWorkflowDocument();
 
         document.setApplicationDocumentStatus(applicationDocumentStatus);
     }
 
     /**
      * method to retrieve the workflow document for the given documentHeader.
      *
      * @return workflowDocument
      */
     @Override
     public WorkflowDocument getWorkflowDocument() {
 
         WorkflowDocument workflowDocument = null;
 
         if (hasWorkflowDocument()) {
             workflowDocument = super.getWorkflowDocument();
         }
 
         try {
             if (workflowDocument != null) {
                 return workflowDocument;
             }
             if ( StringUtils.isNotBlank(getDocumentNumber()) ) {
                 workflowDocument = SpringContext.getBean(WorkflowDocumentService.class).loadWorkflowDocument(getDocumentNumber(), GlobalVariables.getUserSession().getPerson());
             } else {
                 throw new RuntimeException("Document number is blank/null.  Unable to load a WorkflowDocument" );
             }
         }
         catch (WorkflowException we) {
             throw new RuntimeException("Unable to load a WorkflowDocument object for " + getDocumentNumber(), we);
         }
 
         return workflowDocument;
     }
 
     /**
      * Updates status of this document and saves the workflow data
      *
      * @param applicationDocumentStatus is the app doc status to save
      * @throws WorkflowException
      */
     public void updateAndSaveAppDocStatus(String applicationDocumentStatus) throws WorkflowException {
        setApplicationDocumentStatus(applicationDocumentStatus);
        // if the document is Initiated, then it has not been saved yet
        // So, we don't need to save the routing data since the document
        // has not been submitted to the workflow engine yet
        if ( !getWorkflowDocument().isInitiated() ) {
            SpringContext.getBean(WorkflowDocumentService.class).saveRoutingData(getWorkflowDocument());
        }
     }
 
 }