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