View Javadoc
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  /**
37   * Result of an action. <br>
38   * Use :
39   * <ul>
40   * <li>{@link #setRedirect(String)} : if the action need a redirect
41   * <li>{@link #setHtmlContent(String)} : if the action needs to display html content
42   * <li>{@link #setNoop(boolean)} : if no post-action is required (mainly for exports writing directly to the response).
43   * </ul>
44   *
45   */
46  public interface IPluginActionResult
47  {
48      /**
49       * Returns the redirect url, <code>null</code> otherwise.
50       * 
51       * @return the redirect url, <code>null</code> otherwise
52       */
53      String getRedirect( );
54  
55      /**
56       * Sets the redirect url, <code>null</code> otherwise.
57       * 
58       * @param strRedirect
59       *            the redirect url, <code>null</code> otherwise.
60       */
61      void setRedirect( String strRedirect );
62  
63      /**
64       * Returns <code>true</code> if no operation needed, <code>false</code> otherwise.
65       * 
66       * @return <code>true</code> if no operation needed, <code>false</code> otherwise.
67       */
68      boolean isNoop( );
69  
70      /**
71       * Set to <code>true</code> if no operation needed, <code>false</code> otherwise.
72       * 
73       * @param bNoop
74       *            <code>true</code> if no operation needed, <code>false</code> otherwise.
75       */
76      void setNoop( boolean bNoop );
77  
78      /**
79       * Returns the html content if any, <code>null</code> otherwise
80       * 
81       * @return the html content if any, <code>null</code> otherwise
82       */
83      String getHtmlContent( );
84  
85      /**
86       * Sets the html content if any, <code>null</code> otherwise
87       * 
88       * @param strHtmlContent
89       *            the html content if any, <code>null</code> otherwise
90       */
91      void setHtmlContent( String strHtmlContent );
92  }