View Javadoc
1   /*
2    * Copyright (c) 2002-2020, 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.plugins.document.business.spaces;
35  
36  import fr.paris.lutece.portal.service.i18n.I18nService;
37  import fr.paris.lutece.portal.service.i18n.Localizable;
38  import fr.paris.lutece.portal.service.rbac.RBACAction;
39  
40  import java.util.Locale;
41  
42  
43  /**
44   * Action available on a space
45   */
46  public class SpaceAction implements Localizable, RBACAction
47  {
48      // Variables declarations
49      private String _strUrl;
50      private String _strNameKey;
51      private String _strDescriptionKey;
52      private Locale _locale;
53      private String _strIconUrl;
54      private String _strPermission;
55  
56      /**
57       * Implements Localizable
58       * @param locale The current locale
59       */
60      public void setLocale( Locale locale )
61      {
62          _locale = locale;
63      }
64  
65      /**
66       * Returns the Url
67       *
68       * @return The Url
69       */
70      public String getUrl(  )
71      {
72          return _strUrl;
73      }
74  
75      /**
76       * Sets the Url
77       *
78       * @param strUrl The Url
79       */
80      public void setUrl( String strUrl )
81      {
82          _strUrl = strUrl;
83      }
84  
85      /**
86       * Returns the NameKey
87       *
88       * @return The NameKey
89       */
90      public String getNameKey(  )
91      {
92          return _strNameKey;
93      }
94  
95      /**
96       * Returns the Name
97       *
98       * @return The Name
99       */
100     public String getName(  )
101     {
102         return I18nService.getLocalizedString( _strNameKey, _locale );
103     }
104 
105     /**
106      * Sets the NameKey
107      *
108      * @param strNameKey The NameKey
109      */
110     public void setNameKey( String strNameKey )
111     {
112         _strNameKey = strNameKey;
113     }
114 
115     /**
116      * Returns the DescriptionKey
117      *
118      * @return The DescriptionKey
119      */
120     public String getDescriptionKey(  )
121     {
122         return _strDescriptionKey;
123     }
124 
125     /**
126      * Returns the Description
127      *
128      * @return The Description
129      */
130     public String getDescription(  )
131     {
132         return I18nService.getLocalizedString( _strDescriptionKey, _locale );
133     }
134 
135     /**
136      * Sets the DescriptionKey
137      *
138      * @param strDescriptionKey The DescriptionKey
139      */
140     public void setDescriptionKey( String strDescriptionKey )
141     {
142         _strDescriptionKey = strDescriptionKey;
143     }
144 
145     /**
146      * Returns the IconUrl
147      *
148      * @return The IconUrl
149      */
150     public String getIconUrl(  )
151     {
152         return _strIconUrl;
153     }
154 
155     /**
156      * Sets the IconUrl
157      *
158      * @param strIconUrl The IconUrl
159      */
160     public void setIconUrl( String strIconUrl )
161     {
162         _strIconUrl = strIconUrl;
163     }
164 
165     /**
166      * Returns the permission associated to the action
167      * @return The permission
168      */
169     public String getPermission(  )
170     {
171         return _strPermission;
172     }
173 
174     /**
175      * Sets the Permission
176      *
177      * @param strPermission The Permission
178      */
179     public void setPermission( String strPermission )
180     {
181         _strPermission = strPermission;
182     }
183 }