/*
    * 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.fp.document.authorization;
  
  import java.util.Set;
  
  import org.kuali.ole.fp.document.DisbursementVoucherConstants;
  import org.kuali.ole.fp.document.DisbursementVoucherDocument;
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.ole.sys.OleAuthorizationConstants;
  import org.kuali.ole.sys.document.authorization.AccountingDocumentPresentationControllerBase;
  import org.kuali.rice.kew.api.WorkflowDocument;
  import org.kuali.rice.krad.document.Document;
  
  public class DisbursementVoucherDocumentPresentationController extends AccountingDocumentPresentationControllerBase {
      /**
       * @see org.kuali.rice.krad.document.authorization.DocumentPresentationControllerBase#canBlanketApprove(org.kuali.rice.krad.document.Document)
       */
      @Override
      public boolean canBlanketApprove(Document document) {
          return false;
      }
  
      @Override
      public Set<String> getDocumentActions(Document document) {
  
          Set<String> documentActions = super.getDocumentActions(document);
  
          documentActions.remove(OLEConstants.YEAR_END_ACCOUNTING_PERIOD_VIEW_DOCUMENT_ACTION);
          
          return documentActions;
      }
      
      /**
       * @see org.kuali.ole.sys.document.authorization.FinancialSystemTransactionalDocumentPresentationControllerBase#getEditModes(org.kuali.rice.krad.document.Document)
       */
      @Override
      public Set<String> getEditModes(Document document) {
          Set<String> editModes = super.getEditModes(document);
  
          editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.TAX_ENTRY);
          editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.FRN_ENTRY);
          editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.WIRE_ENTRY);
          editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.IMMEDIATE_DISBURSEMENT_ENTRY);
  
          addFullEntryEntryMode(document, editModes);
          addPayeeEditEntryMode(document, editModes);
          addTravelEntryMode(document, editModes);
          addPaymentHandlingEntryMode(document, editModes);
          addVoucherDeadlineEntryMode(document, editModes);
          addSpecialHandlingChagingEntryMode(document, editModes);
  
          return editModes;
      }
  
      protected void addPayeeEditEntryMode(Document document, Set<String> editModes) {
          WorkflowDocument workflowDocument = document.getDocumentHeader().getWorkflowDocument();
  
          if ((workflowDocument.isInitiated() || workflowDocument.isSaved())) {
              editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.PAYEE_ENTRY);
          }
          else if (workflowDocument.isEnroute()) {
              Set<String> currentRouteLevels = workflowDocument.getCurrentNodeNames();
              if (currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.ACCOUNT) || currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.TAX) || currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.AWARD) || currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.CAMPUS) || currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.TRAVEL)) {
                  editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.PAYEE_ENTRY);
              }
          }
      }
      
      protected void addFullEntryEntryMode(Document document, Set<String> editModes) {
          WorkflowDocument workflowDocument = document.getDocumentHeader().getWorkflowDocument();
  
          if ((workflowDocument.isInitiated() || workflowDocument.isSaved())) {
              editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.FULL_ENTRY);
          }
      }
      
      /**
       * If at a proper route node, adds the ability to edit payment handling fields
       * @param document the disbursement voucher document authorization is being sought on
       * @param editModes the edit modes so far, which can be added to
       */
      protected void addPaymentHandlingEntryMode(Document document, Set<String> editModes) {
          final WorkflowDocument workflowDocument = document.getDocumentHeader().getWorkflowDocument();
          
          if ((workflowDocument.isInitiated() || workflowDocument.isSaved())) {
             editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.PAYMENT_HANDLING_ENTRY);
         }
         final Set<String> currentRouteLevels = workflowDocument.getCurrentNodeNames();
         if (currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.ACCOUNT) || currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.CAMPUS) || currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.TRAVEL) || currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.TAX)) {
             editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.PAYMENT_HANDLING_ENTRY);
         }
     }
     
     /**
      * If at a proper route node, adds the ability to edit the due date for the voucher
      * @param document the disbursement voucher document authorization is being sought on
      * @param editModes the edit modes so far, which can be added to
      */
     protected void addVoucherDeadlineEntryMode(Document document, Set<String> editModes) {
         final WorkflowDocument workflowDocument = document.getDocumentHeader().getWorkflowDocument();
         
         if ((workflowDocument.isInitiated() || workflowDocument.isSaved())) {
             editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.VOUCHER_DEADLINE_ENTRY);
         }
         final Set<String> currentRouteLevels = workflowDocument.getCurrentNodeNames();
         if (currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.ACCOUNT) || currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.CAMPUS) || currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.TAX) || currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.TRAVEL)) {
             editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.VOUCHER_DEADLINE_ENTRY);
         }
     }
     
     /**
      * If at a proper route node, adds the ability to edit the travel information on the disbursement voucher
      * @param document the disbursement voucher document authorization is being sought on
      * @param editModes the edit modes so far, which can be added to
      */
     protected void addTravelEntryMode(Document document, Set<String> editModes) {
         final WorkflowDocument workflowDocument = document.getDocumentHeader().getWorkflowDocument();
         
         final Set<String> currentRouteLevels = workflowDocument.getCurrentNodeNames();
         if (currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.ACCOUNT)) {  //FO? 
         } else if (currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.TAX)) { //tax manager? Then only allow this if we're going to route to travel node anyway
             //Commented for the jira issue OLE-3415
             /*if (((DisbursementVoucherDocument)document).isTravelReviewRequired()) {
                editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.TRAVEL_ENTRY);
             }*/
         } else if (currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.PAYMENT_METHOD) && ((DisbursementVoucherDocument)document).getDisbVchrPaymentMethodCode().equals(DisbursementVoucherConstants.PAYMENT_METHOD_DRAFT)) {
             editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.TRAVEL_ENTRY);
         } else {
             editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.TRAVEL_ENTRY); // we're not FO? Then always add it, as KIM permissions will take it out if we shouldn't have it
         }
     }
     
     /**
      * If at a proper route node, adds the ability to edit whether special handling is needed on the disbursement voucher
      * @param document the disbursement voucher document authorization is being sought on
      * @param editModes the edit modes so far, which can be added to
      */
     protected void addSpecialHandlingChagingEntryMode(Document document, Set<String> editModes) {
         final WorkflowDocument workflowDocument = document.getDocumentHeader().getWorkflowDocument();
         final Set<String> currentRouteLevels = workflowDocument.getCurrentNodeNames();
         
         if (!currentRouteLevels.contains(DisbursementVoucherConstants.RouteLevelNames.PURCHASING)) {
             editModes.add(OleAuthorizationConstants.DisbursementVoucherEditMode.SPECIAL_HANDLING_CHANGING_ENTRY);
         }
     }
 }