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 the optimistic locking detects a
21   * modification.
22   *
23   * @svnLink $Revision: 3881 $;$Date: 2009-08-04 15:22:05 +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/ObjectModificationException.java $
24   *
25   * @author Martin Zeltner (MZE)
26   * @deprecated Spring data access exception will be used.
27   * @see org.springframework.dao.OptimisticLockingFailureException
28   */
29  public class ObjectModificationException extends BaseException {
30  	/**
31  	 * Message, which has to be formated.
32  	 */
33  	public static final String EXCEPTION_MESSAGE_OBJECTMODIFICATION
34  		= "{0} was modificated or deleted since meantime.";
35  
36  	/**
37  	 * Name of the object, where the exception occured.
38  	 */
39  	protected String m_objectName;
40  
41  	/**
42  	 * Constructor.
43  	 *
44  	 * @param objectName
45  	 *            Is the name of the object, where the exception occured.
46  	 */
47  	public ObjectModificationException(String objectName) {
48  		this(objectName, (Throwable) null);
49  	}
50  
51  	/**
52  	 * Constructor.
53  	 *
54  	 * @param objectName
55  	 *            Is the name of the object, where the exception occured.
56  	 * @param cause
57  	 *            Is the cause for this exception.
58  	 */
59  	public ObjectModificationException(String objectName, Throwable cause) {
60  		super(EXCEPTION_MESSAGE_OBJECTMODIFICATION, cause);
61  		m_objectName = objectName;
62  	}
63  
64  	/**
65  	 * @return Returns the objectName.
66  	 */
67  	public String getObjectName() {
68  		return m_objectName;
69  	}
70  
71  	/**
72  	 * {@inheritDoc}
73  	 */
74  	public Object[] getFormatParameters() {
75  		return new Object[] {m_objectName};
76  	}
77  }