001/*
002 * Copyright 2008 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.ole.sys.document.web.struts;
017
018import java.util.ArrayList;
019
020import javax.servlet.http.HttpServletRequest;
021import javax.servlet.http.HttpServletResponse;
022
023import org.apache.struts.action.ActionForm;
024import org.apache.struts.action.ActionForward;
025import org.apache.struts.action.ActionMapping;
026import org.kuali.ole.sys.OLEConstants;
027import org.kuali.ole.sys.context.SpringContext;
028import org.kuali.ole.sys.document.Correctable;
029import org.kuali.ole.sys.service.impl.OleParameterConstants;
030import org.kuali.rice.core.api.util.RiceConstants;
031import org.kuali.rice.coreservice.framework.parameter.ParameterService;
032import org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase;
033import org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase;
034import org.kuali.rice.kns.web.ui.ExtraButton;
035import org.kuali.rice.krad.document.Document;
036import org.kuali.rice.krad.util.KRADConstants;
037
038/**
039 * This class...
040 */
041public class FinancialSystemTransactionalDocumentActionBase extends KualiTransactionalDocumentActionBase {
042    public static final String MODULE_LOCKED_MESSAGE = "moduleLockedMessage";
043    public static final String MODULE_LOCKED_URL_SUFFIX = "/moduleLocked.do";
044
045    /**
046     * This action method triggers a correct of the transactional document.
047     *
048     * @param mapping
049     * @param form
050     * @param request
051     * @param response
052     * @return ActionForward
053     * @throws Exception
054     * KRAD Conversion: Customizing the extra buttons on the form
055     */
056    public ActionForward correct(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
057        KualiTransactionalDocumentFormBase tmpForm = (KualiTransactionalDocumentFormBase) form;
058
059        Document document = tmpForm.getDocument();
060
061        ((Correctable) tmpForm.getTransactionalDocument()).toErrorCorrection();
062        tmpForm.setExtraButtons(new ArrayList<ExtraButton>());
063
064        return mapping.findForward(RiceConstants.MAPPING_BASIC);
065    }
066
067    @Override
068    /**
069     * KFSMI-4452
070     */
071    public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
072
073        ActionForward returnForward =  super.execute(mapping, form, request, response);
074        if( isDocumentLocked(mapping, form, request)) {
075            String message  = SpringContext.getBean(ParameterService.class).getParameterValueAsString(OLEConstants.CoreModuleNamespaces.OLE, OleParameterConstants.PARAMETER_ALL_DETAIL_TYPE, OLEConstants.DOCUMENT_LOCKOUT_DEFAULT_MESSAGE);
076            request.setAttribute(MODULE_LOCKED_MESSAGE, message);
077            returnForward = mapping.findForward(RiceConstants.MODULE_LOCKED_MAPPING);
078        }
079
080        return returnForward;
081
082    }
083
084    /**
085     * KFSMI-4452
086     */
087    protected boolean isDocumentLocked(ActionMapping mapping , ActionForm form, HttpServletRequest request) {
088        KualiTransactionalDocumentFormBase tmpForm = (KualiTransactionalDocumentFormBase) form;
089        Document document = tmpForm.getDocument();
090
091        boolean exists = SpringContext.getBean(ParameterService.class).parameterExists(document.getClass(),OLEConstants.DOCUMENT_LOCKOUT_PARM_NM );
092        if(exists) {
093            boolean documentLockedOut = SpringContext.getBean(ParameterService.class).getParameterValueAsBoolean(document.getClass(),OLEConstants.DOCUMENT_LOCKOUT_PARM_NM );
094            if(documentLockedOut) {
095                return tmpForm.getDocumentActions().containsKey(KRADConstants.KUALI_ACTION_CAN_EDIT);
096            }
097        }
098
099        return false;
100    }
101}
102