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