1 /*
2 * Copyright (c) 2002-2017, 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.directory.utils;
35
36 /**
37 *
38 * DirectoryErrorException
39 *
40 */
41 public class DirectoryErrorException extends Exception
42 {
43 private static final long serialVersionUID = 6610609149888544139L;
44 private String _strTitleField;
45 private String _strErrorMessage;
46 private boolean _bMandatoryError;
47
48 /**
49 * Creates a new DirectoryErrorException
50 *
51 * @param strTitleField
52 * The title of the filed that caused the error
53 * @param strErrorMessage
54 * The error message
55 */
56 public DirectoryErrorException( String strTitleField, String strErrorMessage )
57 {
58 _strTitleField = strTitleField;
59 _strErrorMessage = strErrorMessage;
60 _bMandatoryError = false;
61 }
62
63 /**
64 * Creates a new DirectoryErrorException
65 *
66 * @param strTitleField
67 * The title of the filed that caused the error
68 */
69 public DirectoryErrorException( String strTitleField )
70 {
71 _strTitleField = strTitleField;
72 _bMandatoryError = true;
73 }
74
75 /**
76 * return true if the error is a mandatory error
77 *
78 * @return true if the error is a mandatory error
79 */
80 public boolean isMandatoryError( )
81 {
82 return _bMandatoryError;
83 }
84
85 /**
86 * set true if the error is a mandatory error
87 *
88 * @param mandatoryError
89 * true if the error is a mandatory error
90 */
91 public void setMandatoryError( boolean mandatoryError )
92 {
93 _bMandatoryError = mandatoryError;
94 }
95
96 /**
97 * Gets the error Message
98 *
99 * @return the error Message
100 */
101 public String getErrorMessage( )
102 {
103 return _strErrorMessage;
104 }
105
106 /**
107 * set the error message
108 *
109 * @param errorMessage
110 * the erroer message
111 */
112 public void setErrorMessage( String errorMessage )
113 {
114 _strErrorMessage = errorMessage;
115 }
116
117 /**
118 *
119 * @return the title of the field
120 */
121 public String getTitleField( )
122 {
123 return _strTitleField;
124 }
125
126 /**
127 * set the title of the field
128 *
129 * @param titleField
130 * the title of the field
131 */
132 public void setTitleField( String titleField )
133 {
134 _strTitleField = titleField;
135 }
136 }