DefaultPluginActionResult.java

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

  35. /**
  36.  * Result of an action. <br>
  37.  * Use :
  38.  * <ul>
  39.  * <li>{@link #setRedirect(String)} : if the action need a redirect
  40.  * <li>{@link #setHtmlContent(String)} : if the action needs to display html content
  41.  * <li>{@link #setNoop(boolean)} : if no post-action is required (mainly for exports writing directly to the response).
  42.  * </ul>
  43.  *
  44.  */
  45. public class DefaultPluginActionResult implements IPluginActionResult
  46. {
  47.     private String _strRedirect;
  48.     private boolean _bNoop;
  49.     private String _strHtmlContent;

  50.     /**
  51.      * Returns the redirect url, <code>null</code> otherwise.
  52.      *
  53.      * @return the redirect url, <code>null</code> otherwise
  54.      */
  55.     @Override
  56.     public String getRedirect( )
  57.     {
  58.         return _strRedirect;
  59.     }

  60.     /**
  61.      * Sets the redirect url, <code>null</code> otherwise.
  62.      *
  63.      * @param strRedirect
  64.      *            the redirect url, <code>null</code> otherwise.
  65.      */
  66.     @Override
  67.     public void setRedirect( String strRedirect )
  68.     {
  69.         _strRedirect = strRedirect;
  70.     }

  71.     /**
  72.      * Returns <code>true</code> if no operation needed, <code>false</code> otherwise.
  73.      *
  74.      * @return <code>true</code> if no operation needed, <code>false</code> otherwise.
  75.      */
  76.     @Override
  77.     public boolean isNoop( )
  78.     {
  79.         return _bNoop;
  80.     }

  81.     /**
  82.      * Set to <code>true</code> if no operation needed, <code>false</code> otherwise.
  83.      *
  84.      * @param bNoop
  85.      *            <code>true</code> if no operation needed, <code>false</code> otherwise.
  86.      */
  87.     @Override
  88.     public void setNoop( boolean bNoop )
  89.     {
  90.         _bNoop = bNoop;
  91.     }

  92.     /**
  93.      * Returns the html content if any, <code>null</code> otherwise
  94.      *
  95.      * @return the html content if any, <code>null</code> otherwise
  96.      */
  97.     @Override
  98.     public String getHtmlContent( )
  99.     {
  100.         return _strHtmlContent;
  101.     }

  102.     /**
  103.      * Sets the html content if any, <code>null</code> otherwise
  104.      *
  105.      * @param strHtmlContent
  106.      *            the html content if any, <code>null</code> otherwise
  107.      */
  108.     @Override
  109.     public void setHtmlContent( String strHtmlContent )
  110.     {
  111.         _strHtmlContent = strHtmlContent;
  112.     }
  113. }