EntryTypeCheckBox.java
/*
* Copyright (c) 2002-2014, 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.plugins.form.business;
import fr.paris.lutece.plugins.form.utils.FormUtils;
import fr.paris.lutece.portal.service.i18n.I18nService;
import fr.paris.lutece.portal.service.message.AdminMessage;
import fr.paris.lutece.portal.service.message.AdminMessageService;
import fr.paris.lutece.portal.service.util.AppLogService;
import fr.paris.lutece.util.html.Paginator;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import javax.servlet.http.HttpServletRequest;
/**
*
* class EntryTypeCheckBox
*
*/
public class EntryTypeCheckBox extends Entry
{
private final String _template_create = "admin/plugins/form/create_entry_type_check_box.html";
private final String _template_modify = "admin/plugins/form/modify_entry_type_check_box.html";
private final String _template_html_code = "admin/plugins/form/html_code_entry_type_check_box.html";
/**
* Get the HtmlCode of the entry
* @return the HtmlCode of the entry
*
* */
public String getHtmlCode( )
{
return _template_html_code;
}
/**
* Get the request data
* @param request HttpRequest
* @param locale the locale
* @return null if all data requiered are in the request else the url of jsp error
*/
public String getRequestData( HttpServletRequest request, Locale locale )
{
String strTitle = request.getParameter( PARAMETER_TITLE );
String strHelpMessage = ( request.getParameter( PARAMETER_HELP_MESSAGE ) != null )
? request.getParameter( PARAMETER_HELP_MESSAGE ).trim( ) : null;
String strComment = request.getParameter( PARAMETER_COMMENT );
String strMandatory = request.getParameter( PARAMETER_MANDATORY );
String strFieldInLine = request.getParameter( PARAMETER_FIELD_IN_LINE );
int nFieldInLine = -1;
String strFieldError = EMPTY_STRING;
if ( ( strTitle == null ) || strTitle.trim( ).equals( EMPTY_STRING ) )
{
strFieldError = FIELD_TITLE;
}
if ( !strFieldError.equals( EMPTY_STRING ) )
{
Object[] tabRequiredFields = { I18nService.getLocalizedString( strFieldError, locale ) };
return AdminMessageService.getMessageUrl( request, MESSAGE_MANDATORY_FIELD, tabRequiredFields,
AdminMessage.TYPE_STOP );
}
// for don't update fields listFields=null
this.setFields( null );
this.setTitle( strTitle );
this.setHelpMessage( strHelpMessage );
this.setComment( strComment );
if ( strMandatory != null )
{
this.setMandatory( true );
}
else
{
this.setMandatory( false );
}
try
{
nFieldInLine = Integer.parseInt( strFieldInLine );
}
catch ( NumberFormatException ne )
{
AppLogService.error( ne );
}
if ( nFieldInLine == 1 )
{
this.setFieldInLine( true );
}
else
{
this.setFieldInLine( false );
}
return null;
}
/**
* Get template create url of the entry
* @return template create url of the entry
*/
public String getTemplateCreate( )
{
return _template_create;
}
/**
* Get the template modify url of the entry
* @return template modify url of the entry
*/
public String getTemplateModify( )
{
return _template_modify;
}
/**
* The paginator who is use in the template modify of the entry
* @param nItemPerPage Number of items to display per page
* @param strBaseUrl The base Url for build links on each page link
* @param strPageIndexParameterName The parameter name for the page index
* @param strPageIndex The current page index
* @return the paginator who is use in the template modify of the entry
*/
public Paginator getPaginator( int nItemPerPage, String strBaseUrl, String strPageIndexParameterName,
String strPageIndex )
{
return new Paginator( this.getFields( ), nItemPerPage, strBaseUrl, strPageIndexParameterName, strPageIndex );
}
/**
* save in the list of response the response associate to the entry in the form submit
* @param request HttpRequest
* @param listResponse the list of response associate to the entry in the form submit
* @param locale the locale
* @return a Form error object if there is an error in the response
*/
public FormError getResponseData( HttpServletRequest request, List<Response> listResponse, Locale locale )
{
String[] strTabIdField = request.getParameterValues( FormUtils.EMPTY_STRING + this.getIdEntry( ) );
List<Field> listFieldInResponse = new ArrayList<Field>( );
int nIdField = -1;
Field field = null;
Response response;
if ( strTabIdField != null )
{
for ( int cpt = 0; cpt < strTabIdField.length; cpt++ )
{
try
{
nIdField = Integer.parseInt( strTabIdField[cpt] );
}
catch ( NumberFormatException ne )
{
AppLogService.error( ne );
}
field = FormUtils.findFieldByIdInTheList( nIdField, this.getFields( ) );
if ( field != null )
{
listFieldInResponse.add( field );
}
}
}
if ( this.isMandatory( ) )
{
boolean bAllFieldEmpty = true;
for ( Field fieldInResponse : listFieldInResponse )
{
if ( !fieldInResponse.getValue( ).equals( FormUtils.EMPTY_STRING ) )
{
bAllFieldEmpty = false;
}
}
if ( bAllFieldEmpty )
{
FormError formError = new FormError( );
formError.setMandatoryError( true );
formError.setTitleQuestion( this.getTitle( ) );
return formError;
}
}
if ( listFieldInResponse.size( ) == 0 )
{
response = new Response( );
response.setEntry( this );
listResponse.add( response );
}
else
{
for ( Field fieldInResponse : listFieldInResponse )
{
response = new Response( );
response.setEntry( this );
response.setValueResponse( fieldInResponse.getValue( ).getBytes( ) );
response.setField( fieldInResponse );
listResponse.add( response );
}
}
return null;
}
/**
* Get the response value associate to the entry to export in the file export
* @param response the response associate to the entry
* @param locale the locale
* @param request the request
* @return the response value associate to the entry to export in the file export
*/
public String getResponseValueForExport( HttpServletRequest request, Response response, Locale locale )
{
return new String( response.getValueResponse( ) );
}
/**
* Get the response value associate to the entry to write in the recap
* @param response the response associate to the entry
* @param locale the locale
* @param request the request
* @return the response value associate to the entry to write in the recap
*/
public String getResponseValueForRecap( HttpServletRequest request, Response response, Locale locale )
{
return new String( response.getField( ).getTitle( ) );
}
}