/*
    * Copyright 2006-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.module.purap.document.web.struts;
  
  import org.kuali.ole.module.purap.PurapConstants;
  import org.kuali.ole.module.purap.businessobject.ContractManagerAssignmentDetail;
  import org.kuali.ole.module.purap.document.ContractManagerAssignmentDocument;
  import org.kuali.ole.module.purap.document.RequisitionDocument;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.ole.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase;
  import org.kuali.rice.kew.api.KewApiConstants;
  import org.kuali.rice.kew.api.exception.WorkflowException;
  import org.kuali.rice.kns.document.authorization.DocumentAuthorizer;
  import org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase;
  import org.kuali.rice.krad.document.Document;
  import org.kuali.rice.krad.service.DocumentService;
  import org.kuali.rice.krad.util.GlobalVariables;
  
  import java.util.ArrayList;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  /**
   * Struts Action for Contract Manager Assignment document.
   */
  public class ContractManagerAssignmentAction extends FinancialSystemTransactionalDocumentActionBase {
      private static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(ContractManagerAssignmentAction.class);
  
      /**
       * Do initialization for a new <code>ContractManagerAssignmentDocument</code>.
       *
       * @see org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase#createDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase)
       */
      @Override
      protected void createDocument(KualiDocumentFormBase kualiDocumentFormBase) throws WorkflowException {
          super.createDocument(kualiDocumentFormBase);
          ContractManagerAssignmentDocument acmDocument = (ContractManagerAssignmentDocument) kualiDocumentFormBase.getDocument();
          acmDocument.getDocumentHeader().setDocumentDescription(PurapConstants.ASSIGN_CONTRACT_MANAGER_DEFAULT_DESC);
          acmDocument.populateDocumentWithRequisitions();
      }
  
      /**
       * Overrides the method in KualiDocumentActionBase to fetch a List of requisition documents for the
       * ContractManagerAssignmentDocument from documentService, because we need the workflowDocument to get the
       * createDate. If we don't fetch the requisition documents from the documentService, the workflowDocument
       * in the requisition's documentHeader would be null and would cause the transient flexDoc is null error.
       * That's the reason we need this override.
       *
       * @see org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase#loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase)
       */
      @Override
      protected void loadDocument(KualiDocumentFormBase kualiDocumentFormBase) throws WorkflowException {
          super.loadDocument(kualiDocumentFormBase);
          ContractManagerAssignmentDocument document = (ContractManagerAssignmentDocument) kualiDocumentFormBase.getDocument();
          List<String> documentHeaderIds = new ArrayList();
          Map<String, ContractManagerAssignmentDetail> documentHeaderIdsAndDetails = new HashMap();
  
          //Compose a Map in which the keys are the document header ids of each requisition in this acm document and the values are the 
          //corresponding ContractManagerAssignmentDetail object.
          for (ContractManagerAssignmentDetail detail : (List<ContractManagerAssignmentDetail>) document.getContractManagerAssignmentDetails()) {
              documentHeaderIdsAndDetails.put(detail.getRequisition().getDocumentNumber(), detail);
          }
          //Add all of the document header ids (which are the keys of the documentHeaderIdsAndDetails  map) to the 
          //documentHeaderIds List.
          documentHeaderIds.addAll(documentHeaderIdsAndDetails.keySet());
  
          //Get a List of requisition documents from documentService so that we can have the workflowDocument as well
          List<Document> requisitionDocumentsFromDocService = new ArrayList();
          try {
              if (documentHeaderIds.size() > 0)
                  requisitionDocumentsFromDocService = SpringContext.getBean(DocumentService.class).getDocumentsByListOfDocumentHeaderIds(RequisitionDocument.class, documentHeaderIds);
          } catch (WorkflowException we) {
              String errorMsg = "Workflow Exception caught: " + we.getLocalizedMessage();
              LOG.error(errorMsg, we);
              throw new RuntimeException(errorMsg, we);
          }
  
          //Set the documentHeader of the requisition of each of the ContractManagerAssignmentDetail to the documentHeader of
          //the requisitions resulted from the documentService, so that we'll have workflowDocument in the documentHeader.
          for (Document req : requisitionDocumentsFromDocService) {
              ContractManagerAssignmentDetail detail = (ContractManagerAssignmentDetail) documentHeaderIdsAndDetails.get(req.getDocumentNumber());
              detail.getRequisition().setDocumentHeader(req.getDocumentHeader());
          }
      }
  
     @Override
     protected void populateAdHocActionRequestCodes(KualiDocumentFormBase formBase) {
         Document document = formBase.getDocument();
         DocumentAuthorizer documentAuthorizer = getDocumentHelperService().getDocumentAuthorizer(document);
         Map<String, String> adHocActionRequestCodes = new HashMap<String, String>();
 
         if (documentAuthorizer.canSendAdHocRequests(document, KewApiConstants.ACTION_REQUEST_FYI_REQ, GlobalVariables.getUserSession().getPerson())) {
             adHocActionRequestCodes.put(KewApiConstants.ACTION_REQUEST_FYI_REQ, KewApiConstants.ACTION_REQUEST_FYI_REQ_LABEL);
         }
         if ((document.getDocumentHeader().getWorkflowDocument().isInitiated()
                 || document.getDocumentHeader().getWorkflowDocument().isSaved()
                 || document.getDocumentHeader().getWorkflowDocument().isEnroute()
         ) && documentAuthorizer.canSendAdHocRequests(document, KewApiConstants.ACTION_REQUEST_ACKNOWLEDGE_REQ, GlobalVariables.getUserSession().getPerson())) {
             adHocActionRequestCodes.put(KewApiConstants.ACTION_REQUEST_ACKNOWLEDGE_REQ, KewApiConstants.ACTION_REQUEST_ACKNOWLEDGE_REQ_LABEL);
         }
         formBase.setAdHocActionRequestCodes(adHocActionRequestCodes);
 
     }
 
 }