IChooseStateController.java

/*
 * Copyright (c) 2002-2022, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.plugins.workflow.modules.state.service;

import java.util.Locale;

import javax.servlet.http.HttpServletRequest;

import fr.paris.lutece.plugins.workflowcore.business.config.ITaskConfig;
import fr.paris.lutece.plugins.workflowcore.service.task.ITask;

public interface IChooseStateController
{

    /**
     * The label key of the service.
     * 
     * @return
     */
    String getLabelKey( );

    /**
     * The help key of the service.
     * 
     * @return
     */
    String getHelpKey( );

    /**
     * The name of the service.
     * 
     * @return
     */
    String getName( );

    /**
     * controls the result of the control.
     * 
     * @return
     */
    boolean control( ITask task, int nIdResource, String strResourceType );

    /**
     * Indicates if this controller need a config.
     * 
     * @return
     */
    default boolean hasConfig( )
    {
        return false;
    }

    /**
     * Returns the informations which must be displayed in the configuration
     * 
     * @param request
     *            request
     * @param locale
     *            locale
     * @param config
     *            the taskconfig
     * @return the information which must be displayed in the task configuration
     */
    default String getDisplayConfigForm( HttpServletRequest request, Locale locale, ITaskConfig config )
    {
        return null;
    }

    /**
     * Process the action during the configuration of the task.
     * 
     * @param request
     * @param locale
     * @param config
     */
    default void doSaveConfig( HttpServletRequest request, Locale locale, ITask task )
    {
    }

    /**
     * Delete controller custom config.
     * 
     * @param task
     */
    default void doRemoveConfig( ITask task )
    {
    }
}