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.workflow.modules.mappings.business;
35
36 import fr.paris.lutece.plugins.workflow.modules.mappings.business.type.IMappingType;
37
38 import java.util.Locale;
39
40
41 /**
42 *
43 * This interface represents the code mapping between a code
44 * and its refence code.
45 *
46 */
47 public interface ICodeMapping
48 {
49 /**
50 * Get the id code
51 * @return the id code
52 */
53 int getIdCode( );
54
55 /**
56 * Set the id code
57 * @param nIdCode the id code
58 */
59 void setIdCode( int nIdCode );
60
61 /**
62 * Get the code
63 * @return the code
64 */
65 String getCode( );
66
67 /**
68 * Set the code
69 * @param strCode the code
70 */
71 void setCode( String strCode );
72
73 /**
74 * Get the label code
75 * @return the label code
76 */
77 String getLabelCode( );
78
79 /**
80 * Set the label code
81 * @param strLabel the label code
82 */
83 void setLabelCode( String strLabel );
84
85 /**
86 * Get the reference code
87 * @return the reference code
88 */
89 String getReferenceCode( );
90
91 /**
92 * Set the reference code
93 * @param strReferenceCode the reference code
94 */
95 void setReferenceCode( String strReferenceCode );
96
97 /**
98 * Get the labem reference code
99 * @param locale the Locale
100 * @return the label reference code
101 */
102 String getLabelReferenceCode( Locale locale );
103
104 /**
105 * Get the mapping type
106 * @return the mapping type
107 */
108 IMappingType getMappingType( );
109
110 /**
111 * Set the mapping type
112 * @param mappingType the mapping type
113 */
114 void setMappingType( IMappingType mappingType );
115
116 /**
117 * Check if the code mapping is in strict mode.
118 * @return true if the code mapping is in strict mode, false otherwise
119 */
120 boolean isStrict( );
121
122 /**
123 * In strict mode, the reference code must be UNIQUE along with the code and
124 * the mapping type key. In other words, when creating/modifying a code mapping,
125 * the strict mode will ensure that the code is UNIQUE.
126 * <br />
127 * The mode is strict by default ({@link #isStrict()} == true)
128 * @param bIsStrict true if the code mapping is in strict mode, false otherwise
129 */
130 void setStrict( boolean bIsStrict );
131 }