1 /*
2 * Copyright (c) 2002-2022, 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.util;
35
36 /**
37 * This class is the representation of a ReferenceItem composed of a code and a name. It also provides the methods to access to those attributes.
38 */
39 public class ReferenceItem
40 {
41 private String _strCode;
42 private String _strName;
43 private boolean _bChecked;
44
45 /**
46 * Returns the code of this ReferenceItem object as a String
47 *
48 * @return The code
49 */
50 public String getCode( )
51 {
52 return _strCode;
53 }
54
55 /**
56 * Sets the code of this ReferenceItem with the String specified in parameter
57 *
58 * @param strCode
59 * The new String value of the code
60 */
61 public void setCode( String strCode )
62 {
63 _strCode = strCode;
64 }
65
66 /**
67 * Returns the name of this ReferenceItem object as a String
68 *
69 * @return the name
70 */
71 public String getName( )
72 {
73 return _strName;
74 }
75
76 /**
77 * Sets the name of this ReferenceItem object with the value specified in parameter
78 *
79 * @param strName
80 * new String value of the name
81 */
82 public void setName( String strName )
83 {
84 _strName = strName;
85 }
86
87 /**
88 * Returns weither the item is checked or not
89 *
90 * @return true if checked, otherwise false
91 * @since 2.0
92 */
93 public boolean isChecked( )
94 {
95 return _bChecked;
96 }
97
98 /**
99 * Sets checked
100 *
101 * @param bChecked
102 * The check status
103 * @since 2.0
104 */
105 public void setChecked( boolean bChecked )
106 {
107 _bChecked = bChecked;
108 }
109
110 /**
111 * {@inheritDoc}
112 */
113 @Override
114 public String toString( )
115 {
116 return "RefItem[Name=" + this.getName( ) + ", Code=" + this.getCode( ) + ", Checked=" + this.isChecked( ) + "]";
117 }
118 }