ResultAction.java

/**
 * Hudson Serenitec plugin
 *
 * @author Georges Bossert <gbossert@gmail.com>
 * @version $Revision: 1.5 $
 * @since $Date: 2008/07/24 09:44:14 ${date}
 * @copyright Universit� de Rennes 1
 */
package hudson.plugins.serenitec.util;


import hudson.model.Action;

import java.io.IOException;
import java.util.NoSuchElementException;

import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;

/**
 * Defines an action that is responsible for handling results of the given type <code>T</code>.
 * 
 * @param <T>
 *            type of the result
 * @author Ulli Hafner
 */
public interface ResultAction<T> extends Action
{

    /**
     * Returns the current result of this action.
     * 
     * @return the current result
     */
    T getResult();

    /**
     * Sets the result for this build.
     * 
     * @param result
     *            the result to set
     */
    void setResult(final T result);

    /**
     * Returns whether a previous build already has a result action of this type attached.
     * 
     * @return <code>true</code> a previous build already has a result action of this type attached
     */
    boolean hasPreviousResultAction();

    /**
     * Returns the result action from the previous build.
     * 
     * @return the result of the previous build.
     * @throws NoSuchElementException
     *             if there is no previous result action is found
     */
    ResultAction<T> getPreviousResultAction();

    /**
     * Generates a PNG image showing the trend graph for this result action.
     * 
     * @param request
     *            Stapler request
     * @param response
     *            Stapler response
     * @param height
     *            the height of the trend graph
     * @throws IOException
     *             in case of an error
     */
    void doGraph(StaplerRequest request, StaplerResponse response, int height) throws IOException;

    /**
     * Generates a PNG image showing personnal graph for this result action.
     * 
     * @param request
     *            Stapler request
     * @param response
     *            Stapler response
     * @param height
     *            the height of the trend graph
     * @throws IOException
     *             in case of an error
     */
    void doPersonalGraph(StaplerRequest request, StaplerResponse response, int height, String type) throws IOException;

    void doRulesRepartitionPie(StaplerRequest request, StaplerResponse response, int size, int n1, int n2, String titre) throws IOException;

    /**
     * Generates a clickable map for the trend graph of this result action.
     * 
     * @param request
     *            Stapler request
     * @param response
     *            Stapler response
     * @param height
     *            the height of the trend graph
     * @throws IOException
     *             in case of an error
     */
    void doGraphMap(StaplerRequest request, StaplerResponse response, int height) throws IOException;

    /**
     * Returns the associated health report builder.
     * 
     * @return the associated health report builder
     */
    HealthReportBuilder getHealthReportBuilder();
}