CaseHandlingDispatchAction.java

/**
 * Copyright © 2002 Instituto Superior Técnico
 *
 * This file is part of FenixEdu Academic.
 *
 * FenixEdu Academic is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * FenixEdu Academic is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with FenixEdu Academic.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.fenixedu.academic.ui.struts.action.casehandling;

import java.util.Collection;
import java.util.Set;
import java.util.TreeSet;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.fenixedu.academic.domain.caseHandling.Activity;
import org.fenixedu.academic.domain.caseHandling.PreConditionNotValidException;
import org.fenixedu.academic.domain.caseHandling.Process;
import org.fenixedu.academic.service.services.caseHandling.CreateNewProcess;
import org.fenixedu.academic.service.services.caseHandling.ExecuteProcessActivity;
import org.fenixedu.academic.service.services.exceptions.FenixServiceException;
import org.fenixedu.academic.ui.struts.action.base.FenixDispatchAction;
import org.fenixedu.bennu.core.domain.User;
import org.fenixedu.bennu.core.security.Authenticate;

public abstract class CaseHandlingDispatchAction extends FenixDispatchAction {

    abstract protected Class getProcessType();

    @Override
    public ActionForward execute(ActionMapping mapping, ActionForm actionForm, HttpServletRequest request,
            HttpServletResponse response) throws Exception {
        setProcessName(request);
        setProcess(request);
        return super.execute(mapping, actionForm, request, response);
    }

    protected void setProcessName(final HttpServletRequest request) {
        request.setAttribute("processName", getProcessType().getSimpleName());
    }

    protected Process readProcess(final HttpServletRequest request) {
        return getDomainObject(request, "processId");
    }

    protected void setProcess(final HttpServletRequest request) {
        final Process process = readProcess(request);
        if (process != null) {
            request.setAttribute("process", process);
        }
    }

    protected Collection<Process> getAllowedProcessInstances(final User userView) {
        final Set<Process> result = new TreeSet<Process>();
        for (final Process process : rootDomainObject.getProcessesSet()) {
            if (process.getClass().equals(getProcessType()) && process.canExecuteActivity(userView)) {
                result.add(process);
            }
        }
        return result;
    }

    protected Process getProcess(final HttpServletRequest request) {
        return (Process) request.getAttribute("process");
    }

    protected boolean hasProcess(final HttpServletRequest request) {
        return getProcess(request) != null;
    }

    public ActionForward listProcesses(ActionMapping mapping, ActionForm form, HttpServletRequest request,
            HttpServletResponse response) {
        request.setAttribute("canCreateProcess", canCreateProcess(getProcessType().getName()));
        request.setAttribute("processes", getAllowedProcessInstances(Authenticate.getUser()));
        return mapping.findForward("list-processes");
    }

    protected Object canCreateProcess(final String name) {
        try {
            final Activity<?> startActivity = Process.getStartActivity(name);
            startActivity.checkPreConditions(null, Authenticate.getUser());
        } catch (PreConditionNotValidException e) {
            return false;
        }
        return true;
    }

    public ActionForward listProcessAllowedActivities(ActionMapping mapping, ActionForm form, HttpServletRequest request,
            HttpServletResponse response) {
        final Process process = getProcess(request);
        request.setAttribute("activities", process.getAllowedActivities(Authenticate.getUser()));
        return mapping.findForward("list-allowed-activities");
    }

    abstract public ActionForward prepareCreateNewProcess(ActionMapping mapping, ActionForm form, HttpServletRequest request,
            HttpServletResponse response);

    public ActionForward createNewProcess(ActionMapping mapping, ActionForm form, HttpServletRequest request,
            HttpServletResponse response) throws FenixServiceException {
        Process process = CreateNewProcess.run(getProcessType().getName(), getRenderedObject());
        request.setAttribute("process", process);
        return listProcessAllowedActivities(mapping, form, request, response);
    }

    protected void executeActivity(Process process, String activityId) throws FenixServiceException {
        executeActivity(process, activityId, null);
    }

    protected Process executeActivity(Process process, String activityId, Object object) throws FenixServiceException {
        return ExecuteProcessActivity.run(process, activityId, object);
    }

}