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