1 /*
2 * Copyright (c) 2002-2017, 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.plugins.mylutece.modules.notification.business.folder;
35
36 import java.util.Locale;
37
38
39 /**
40 *
41 * IFolder
42 *
43 */
44 public interface IFolder
45 {
46 /**
47 * Get the id folder
48 * @return the id folder
49 */
50 int getIdFolder( );
51
52 /**
53 * Set the id folder
54 * @param nIdFolder the id folder
55 */
56 void setIdFolder( int nIdFolder );
57
58 /**
59 * Get the url icon
60 * @return the url icon
61 */
62 String getUrlIcon( );
63
64 /**
65 * Set the url icon
66 * @param strUrlIcon the url icon
67 */
68 void setUrlIcon( String strUrlIcon );
69
70 /**
71 * Get the user guid
72 * @return the user guid
73 */
74 String getUserGuid( );
75
76 /**
77 * Set the user guid
78 * @param strUserGuid the user guid
79 */
80 void setUserGuid( String strUserGuid );
81
82 /**
83 * Check if the folder is editable
84 * @return true if it is editable, false otherwise
85 */
86 boolean isEditable( );
87
88 /**
89 * Get the label
90 * @return the label
91 */
92 String getLabel( );
93
94 /**
95 * Set the label
96 * @param strLabel the label
97 */
98 void setLabel( String strLabel );
99
100 /**
101 * Set the folder type
102 * @param locale {@link Locale}
103 */
104 void setFolderType( Locale locale );
105
106 /**
107 * Get the folder type
108 * @return the {@link FolderType}
109 */
110 FolderType getFolderType( );
111
112 /**
113 * Get the number of notification given an user guid
114 * @param strUserGuid the user guid
115 * @return the number of notifications
116 */
117 int getNumberNotifications( String strUserGuid );
118
119 /**
120 * Get the number of unread notification given an user guid
121 * @param strUserGuid the user guid
122 * @return the number of unread notifications
123 */
124 int getNumberUnreadNotifications( String strUserGuid );
125 }