1 /*
2 * Copyright (c) 2002-2014, Mairie de 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.plugin.Plugin;
38
39 import javax.servlet.http.HttpServletRequest;
40
41
42 /**
43 *
44 * IDashboardComponent
45 *
46 */
47 public interface IDashboardComponent extends Comparable<IDashboardComponent>
48 {
49 /**
50 * Gets dashboard data for a given user
51 * @param user The user
52 * @param request HttpServletRequest
53 * @return HTML content to insert into a dashboard zone
54 */
55 String getDashboardData( AdminUser user, HttpServletRequest request );
56
57 /**
58 * Returns the Name
59 * @return The Name
60 */
61 String getName( );
62
63 /**
64 * Sets the Name
65 * @param strName The Name
66 */
67 void setName( String strName );
68
69 /**
70 * Returns the Right
71 * @return The Right
72 */
73 String getRight( );
74
75 /**
76 * Sets the Right
77 * @param strRight The Right
78 */
79 void setRight( String strRight );
80
81 /**
82 * Returns the Zone
83 * @return The Zone
84 */
85 int getZone( );
86
87 /**
88 * Sets the Zone
89 * @param nZone The Zone
90 */
91 void setZone( int nZone );
92
93 /**
94 * Returns the Order
95 * @return The Order
96 */
97 int getOrder( );
98
99 /**
100 * Sets the Order
101 * @param nOrder The Order
102 */
103 void setOrder( int nOrder );
104
105 /**
106 * Returns the Plugin
107 * @return The Plugin
108 */
109 Plugin getPlugin( );
110
111 /**
112 * Sets the Plugin
113 * @param plugin The plugin
114 */
115 void setPlugin( Plugin plugin );
116
117 /**
118 * Tells if the component is enabled
119 * @return true if enabled
120 */
121 boolean isEnabled( );
122 }