/*
* Copyright (c) 2002-2016, Mairie de 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.portal.service.panel;
import java.util.Locale;
import javax.servlet.http.HttpServletRequest;
/**
* Interface SEO Panel
*/
public interface LutecePanel
{
/**
* Returns the panel's title
*
* @return The title
*/
String getPanelKey( );
/**
* Returns the panel's title
*
* @return The title
*/
String getPanelTitle( );
/**
* Returns the panel's content
*
* @return The content
*/
String getPanelContent( );
/**
* Returns the panel's order
*
* @return The order
*/
int getPanelOrder( );
/**
* Sets the panel's locale
*
* @param locale
* The locale
*/
void setPanelLocale( Locale locale );
/**
* Gets the locale
*
* @return The locale
*/
Locale getPanelLocale( );
/**
* Sets the request
*
* @param request
* The request
*/
void setRequest( HttpServletRequest request );
/**
* Gets the request
*
* @return The request
*/
HttpServletRequest getRequest( );
/**
* Gets the panel index
*
* @return The index
*/
int getPanelIndex( );
}