fr.paris.lutece.plugins.form.business.outputprocessor
Interface IOutputProcessor

All Known Implementing Classes:
OutputProcessor, ProcessorNotifySender

public interface IOutputProcessor

IOutputProcessor


Method Summary
 java.lang.String doOutputConfigForm(javax.servlet.http.HttpServletRequest request, java.util.Locale locale, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Store the processor configuration
 java.lang.String getKey()
          Get the processor key
 java.lang.String getOutputConfigForm(javax.servlet.http.HttpServletRequest request, Form form, java.util.Locale locale, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Return the processor configuration interface
 java.lang.String process(FormSubmit formSubmit, javax.servlet.http.HttpServletRequest request, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Process the OutputProcessor
 void setKey(java.lang.String strKey)
          set the processor key
 

Method Detail

getKey

java.lang.String getKey()
Get the processor key

Returns:
the processor key

setKey

void setKey(java.lang.String strKey)
set the processor key

Parameters:
strKey - the processor key

getOutputConfigForm

java.lang.String getOutputConfigForm(javax.servlet.http.HttpServletRequest request,
                                     Form form,
                                     java.util.Locale locale,
                                     fr.paris.lutece.portal.service.plugin.Plugin plugin)
Return the processor configuration interface

Parameters:
form - the form wich using the processor
locale - Locale
plugin - Plugin
Returns:
the processor configuration interface

doOutputConfigForm

java.lang.String doOutputConfigForm(javax.servlet.http.HttpServletRequest request,
                                    java.util.Locale locale,
                                    fr.paris.lutece.portal.service.plugin.Plugin plugin)
Store the processor configuration

Parameters:
request - HttpServletRequest
locale - Locale
plugin - Plugin
Returns:
a message error if a error appear else null

process

java.lang.String process(FormSubmit formSubmit,
                         javax.servlet.http.HttpServletRequest request,
                         fr.paris.lutece.portal.service.plugin.Plugin plugin)
Process the OutputProcessor

Parameters:
formSubmit - the formSubmit associate to the process
request - HttpServletRequest
plugin - Plugin
Returns:
a message error if a error appear else null


Copyright © 2010 Mairie de Paris. All Rights Reserved.