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