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.attributes; 35 36 import fr.paris.lutece.portal.service.i18n.I18nService; 37 import fr.paris.lutece.portal.service.i18n.Localizable; 38 39 import java.util.Locale; 40 41 /** 42 * This class represents the business object DocumentAttributeType 43 */ 44 public class AttributeType implements Localizable 45 { 46 // Variables declarations 47 private String _strCode; 48 private String _strNameKey; 49 private String _strDescriptionKey; 50 private String _strClassName; 51 private Locale _locale; 52 53 /** 54 * Returns the Code 55 * 56 * @return The Code 57 */ 58 public String getCode( ) 59 { 60 return _strCode; 61 } 62 63 /** 64 * Sets the Code 65 * 66 * @param strCode 67 * The Code 68 */ 69 public void setCode( String strCode ) 70 { 71 _strCode = strCode; 72 } 73 74 /** 75 * Returns the Locale 76 * 77 * @return The Locale 78 */ 79 public Locale getLocale( ) 80 { 81 return _locale; 82 } 83 84 /** 85 * Sets the Locale 86 * 87 * @param locale 88 * The Locale 89 */ 90 public void setLocale( Locale locale ) 91 { 92 _locale = locale; 93 } 94 95 /** 96 * Returns the Name 97 * 98 * @return The Name 99 */ 100 public String getNameKey( ) 101 { 102 return _strNameKey; 103 } 104 105 /** 106 * Sets the Name 107 * 108 * @param strNameKey 109 * The Name 110 */ 111 public void setNameKey( String strNameKey ) 112 { 113 _strNameKey = strNameKey; 114 } 115 116 /** 117 * Returns the Description 118 * 119 * @return The Description 120 */ 121 public String getDescriptionKey( ) 122 { 123 return _strDescriptionKey; 124 } 125 126 /** 127 * Sets the Description 128 * 129 * @param strDescriptionKey 130 * The Description 131 */ 132 public void setDescriptionKey( String strDescriptionKey ) 133 { 134 _strDescriptionKey = strDescriptionKey; 135 } 136 137 /** 138 * Returns the ClassName 139 * 140 * @return The ClassName 141 */ 142 public String getClassName( ) 143 { 144 return _strClassName; 145 } 146 147 /** 148 * Sets the ClassName 149 * 150 * @param strClassName 151 * The ClassName 152 */ 153 public void setClassName( String strClassName ) 154 { 155 _strClassName = strClassName; 156 } 157 158 /** 159 * Returns the Name 160 * 161 * @return The Name 162 */ 163 public String getName( ) 164 { 165 return I18nService.getLocalizedString( _strNameKey, _locale ); 166 } 167 168 /** 169 * Returns the Description 170 * 171 * @return The Description 172 */ 173 public String getDescription( ) 174 { 175 return I18nService.getLocalizedString( _strDescriptionKey, _locale ); 176 } 177 }