View Javadoc

1   /*
2    * EL4J, the Extension Library for the J2EE, adds incremental enhancements to
3    * the spring framework, http://el4j.sf.net
4    * Copyright (C) 2005 by ELCA Informatique SA, Av. de la Harpe 22-24,
5    * 1000 Lausanne, Switzerland, http://www.elca.ch
6    *
7    * EL4J is published under the GNU Lesser General Public License (LGPL)
8    * Version 2.1. See http://www.gnu.org/licenses/
9    *
10   * This program is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13   * GNU Lesser General Public License for more details.
14   *
15   * For alternative licensing, please contact info@elca.ch
16   */
17  package ch.elca.el4j.core.exceptions;
18  
19  /**
20   * This exception will be thrown when a field, which has to be unique, has
21   * already the same value as the given.
22   *
23   * @svnLink $Revision: 3874 $;$Date: 2009-08-04 14:25:40 +0200 (Di, 04. Aug 2009) $;$Author: swismer $;$URL: https://el4j.svn.sourceforge.net/svnroot/el4j/branches/el4j_3_1/el4j/framework/modules/core/src/main/java/ch/elca/el4j/core/exceptions/DuplicatedFieldException.java $
24   *
25   * @author Martin Zeltner (MZE)
26   * @deprecated Spring data access exception will be used.
27   * @see org.springframework.dao.DataIntegrityViolationException
28   */
29  public class DuplicatedFieldException extends BaseException {
30  	/**
31  	 * Message, which has to be formated.
32  	 */
33  	public static final String EXCEPTION_MESSAGE_FIELDDUPLICATED
34  		= "A {0} with the same {1} already exists in database.";
35  
36  	/**
37  	 * Name of the object, where the exception occured.
38  	 */
39  	protected String m_objectName;
40  
41  	/**
42  	 * Name of the field, which would be duplicated.
43  	 */
44  	protected String m_fieldName;
45  
46  	/**
47  	 * Constructor.
48  	 *
49  	 * @param objectName
50  	 *            Is the name of the object, where the exception occured.
51  	 * @param fieldName
52  	 *            Is the name of the field, which would be duplicated.
53  	 */
54  	public DuplicatedFieldException(String objectName, String fieldName) {
55  		this(objectName, fieldName, (Throwable) null);
56  	}
57  
58  	/**
59  	 * Constructor.
60  	 *
61  	 * @param objectName
62  	 *            Is the name of the object, where the exception occured.
63  	 * @param fieldName
64  	 *            Is the name of the field, which would be duplicated.
65  	 * @param cause
66  	 *            Is the cause for this exception.
67  	 */
68  	public DuplicatedFieldException(String objectName, String fieldName,
69  			Throwable cause) {
70  		super(EXCEPTION_MESSAGE_FIELDDUPLICATED, cause);
71  		m_objectName = objectName;
72  		m_fieldName = fieldName;
73  	}
74  
75  	/**
76  	 * @return Returns the objectName.
77  	 */
78  	public String getObjectName() {
79  		return m_objectName;
80  	}
81  
82  	/**
83  	 * @return Returns the fieldName.
84  	 */
85  	public String getFieldName() {
86  		return m_fieldName;
87  	}
88  
89  	/**
90  	 * {@inheritDoc}
91  	 */
92  	public Object[] getFormatParameters() {
93  		return new Object[] {m_objectName, m_fieldName};
94  	}
95  }