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 class DefaultPluginActionResult implements IPluginActionResult
47 {
48 private String _strRedirect;
49 private boolean _bNoop;
50 private String _strHtmlContent;
51
52 /**
53 * Returns the redirect url, <code>null</code> otherwise.
54 *
55 * @return the redirect url, <code>null</code> otherwise
56 */
57 @Override
58 public String getRedirect( )
59 {
60 return _strRedirect;
61 }
62
63 /**
64 * Sets the redirect url, <code>null</code> otherwise.
65 *
66 * @param strRedirect
67 * the redirect url, <code>null</code> otherwise.
68 */
69 @Override
70 public void setRedirect( String strRedirect )
71 {
72 _strRedirect = strRedirect;
73 }
74
75 /**
76 * Returns <code>true</code> if no operation needed, <code>false</code> otherwise.
77 *
78 * @return <code>true</code> if no operation needed, <code>false</code> otherwise.
79 */
80 @Override
81 public boolean isNoop( )
82 {
83 return _bNoop;
84 }
85
86 /**
87 * Set to <code>true</code> if no operation needed, <code>false</code> otherwise.
88 *
89 * @param bNoop
90 * <code>true</code> if no operation needed, <code>false</code> otherwise.
91 */
92 @Override
93 public void setNoop( boolean bNoop )
94 {
95 _bNoop = bNoop;
96 }
97
98 /**
99 * Returns the html content if any, <code>null</code> otherwise
100 *
101 * @return the html content if any, <code>null</code> otherwise
102 */
103 @Override
104 public String getHtmlContent( )
105 {
106 return _strHtmlContent;
107 }
108
109 /**
110 * Sets the html content if any, <code>null</code> otherwise
111 *
112 * @param strHtmlContent
113 * the html content if any, <code>null</code> otherwise
114 */
115 @Override
116 public void setHtmlContent( String strHtmlContent )
117 {
118 _strHtmlContent = strHtmlContent;
119 }
120 }