IFormPanelConfiguration.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.forms.business.form.panel.configuration;

import java.util.List;

import fr.paris.lutece.plugins.forms.business.form.panel.FormPanel;
import fr.paris.lutece.plugins.forms.web.form.panel.display.IFormPanelDisplay;
import fr.paris.lutece.portal.service.rbac.RBACResource;

/**
 * Configuration for a FormPanel
 */
public interface IFormPanelConfiguration extends RBACResource
{

    public static final String RESOURCE_TYPE = "FORM_PANEL_CONF";

    /**
     * Return the technical code of the FormPanel
     * 
     * @return the technical code of the FormPanel
     */
    String getTechnicalCode( );

    /**
     * Return the position of the FormPanel
     * 
     * @return the position of the FormPanel
     */
    int getPosition( );

    /**
     * Return the title of the FormPanel
     * 
     * @return the title of the FormPanel
     */
    String getTitle( );

    /**
     * Return the list of FormPanelInitializer class name of the FormPanelConfiguration
     * 
     * @return the list of FormPanelInitializer class name of the FormPanelConfiguration
     */
    List<String> getListFormPanelInitializerName( );

    @Override
    default String getResourceTypeCode( )
    {
        return RESOURCE_TYPE;
    }

    @Override
    default String getResourceId( )
    {
        return getTechnicalCode( );
    }

    /**
     * Get an {@link IFormPanelDisplay} associated with is IFormPanelConfiguration.
     * 
     * @return
     */
    IFormPanelDisplay getFormPanelDisplay( FormPanel formPanel );
}