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.service.dashboard;
35
36 import fr.paris.lutece.portal.business.user.AdminUser;
37 import fr.paris.lutece.portal.service.i18n.Localizable;
38 import fr.paris.lutece.portal.service.plugin.Plugin;
39
40 import javax.servlet.http.HttpServletRequest;
41
42 /**
43 *
44 * IDashboardComponent
45 *
46 */
47 public interface IDashboardComponent extends Comparable<IDashboardComponent>, Localizable
48 {
49 /**
50 * Gets dashboard data for a given user
51 *
52 * @param user
53 * The user
54 * @param request
55 * HttpServletRequest
56 * @return HTML content to insert into a dashboard zone
57 */
58 String getDashboardData( AdminUser user, HttpServletRequest request );
59
60 /**
61 * Returns the Name
62 *
63 * @return The Name
64 */
65 String getName( );
66
67 /**
68 * Sets the Name
69 *
70 * @param strName
71 * The Name
72 */
73 void setName( String strName );
74
75 /**
76 * Returns the Right
77 *
78 * @return The Right
79 */
80 String getRight( );
81
82 /**
83 * Sets the Right
84 *
85 * @param strRight
86 * The Right
87 */
88 void setRight( String strRight );
89
90 /**
91 * Returns the Zone
92 *
93 * @return The Zone
94 */
95 int getZone( );
96
97 /**
98 * Sets the Zone
99 *
100 * @param nZone
101 * The Zone
102 */
103 void setZone( int nZone );
104
105 /**
106 * Returns the Order
107 *
108 * @return The Order
109 */
110 int getOrder( );
111
112 /**
113 * Sets the Order
114 *
115 * @param nOrder
116 * The Order
117 */
118 void setOrder( int nOrder );
119
120 /**
121 * Returns the Plugin
122 *
123 * @return The Plugin
124 */
125 Plugin getPlugin( );
126
127 /**
128 * Sets the Plugin
129 *
130 * @param plugin
131 * The plugin
132 */
133 void setPlugin( Plugin plugin );
134
135 /**
136 * Tells if the component is enabled
137 *
138 * @return true if enabled
139 */
140 boolean isEnabled( );
141
142 /**
143 * Returns a localized description
144 *
145 * @return a localized description
146 */
147 String getDescription( );
148 }