Processor.java

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014 México Abierto
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * For more information visit https://github.com/mxabierto/avisos.
*/

package mx.org.cedn.avisosconagua.engine;

import com.mongodb.BasicDBObject;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Interface that defines methods to implement in workflow processors.
 * @author serch
 */
public interface Processor {
    /**
     * Invokes form construction in a GET request for a given step in the controller workflows.
     * @param request servlet request
     * @param response servlet response
     * @param data MongoDB object with submitted information
     * @param parts uri path string parts
     * @throws ServletException
     * @throws IOException 
     */
    void invokeForm(HttpServletRequest request, HttpServletResponse response, BasicDBObject data, String[] parts) throws ServletException, IOException;
    
    /**
     * Process data sent from a form in a POST request for a given step in the controller workflows.
     * @param request servlet request
     * @param parts uri path string parts
     * @param currentId current ID for the MongoDB object
     * @throws ServletException
     * @throws IOException 
     */
    void processForm(HttpServletRequest request, String[] parts, String currentId)throws ServletException, IOException;   
}