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.workflow;
35
36 import fr.paris.lutece.portal.service.i18n.I18nService;
37
38 import java.util.Locale;
39
40 /**
41 *
42 */
43 public class DocumentState
44 {
45 // Variables declarations
46 public static final int STATE_WRITING = 1;
47 public static final int STATE_WAITING_FOR_APPROVAL = 2;
48 public static final int STATE_VALIDATE = 3;
49 public static final int STATE_REJECTED = 4;
50 public static final int STATE_ARCHIVED = 5;
51 public static final int STATE_IN_CHANGE = 6;
52 public static final int STATE_WAITING_FOR_CHANGE_APPROVAL = 7;
53 private int _nIdState;
54 private Locale _locale;
55 private String _strNameKey;
56 private String _strDescriptionKey;
57
58 /**
59 * Returns the IdState
60 *
61 * @return The IdState
62 */
63 public int getId( )
64 {
65 return _nIdState;
66 }
67
68 /**
69 * Sets the IdState
70 *
71 * @param nIdState
72 * The IdState
73 */
74 public void setId( int nIdState )
75 {
76 _nIdState = nIdState;
77 }
78
79 /**
80 * Sets the Locale
81 *
82 * @param locale
83 * the locale
84 */
85 public void setLocale( Locale locale )
86 {
87 _locale = locale;
88 }
89
90 /**
91 * Returns the NameKey
92 *
93 * @return The NameKey
94 */
95 public String getNameKey( )
96 {
97 return _strNameKey;
98 }
99
100 /**
101 * Sets the NameKey
102 *
103 * @param strNameKey
104 * The NameKey
105 */
106 public void setNameKey( String strNameKey )
107 {
108 _strNameKey = strNameKey;
109 }
110
111 /**
112 * Returns the DescriptionKey
113 *
114 * @return The DescriptionKey
115 */
116 public String getDescriptionKey( )
117 {
118 return _strDescriptionKey;
119 }
120
121 /**
122 * Sets the DescriptionKey
123 *
124 * @param strDescriptionKey
125 * The DescriptionKey
126 */
127 public void setDescriptionKey( String strDescriptionKey )
128 {
129 _strDescriptionKey = strDescriptionKey;
130 }
131
132 /**
133 * Returns the Name
134 *
135 * @return The Name
136 */
137 public String getName( )
138 {
139 return I18nService.getLocalizedString( _strNameKey, _locale );
140 }
141 }