/**
 * <copyright> Copyright (c) 2006 by Know-Center, Graz, Austria </copyright>
 * 
 * This software is the confidential and proprietary information of Know-Center,
 * Graz, Austria. You shall not disclose such Confidential Information and shall
 * use it only in accordance with the terms of the license agreement you entered
 * into with Know-Center.
 * 
 * KNOW-CENTER MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF
 * THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
 * NON-INFRINGEMENT. KNOW-CENTER SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY
 * LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
 * DERIVATIVES.
 * 
 * $Id: PresentableException.java,v 1.2 2006/08/25 17:10:34 wprinz Exp $
 */
package at.knowcenter.wag.egov.egiz.exceptions;

/**
 * This exception should be the base for all exceptions that are to be presented
 * to the user.
 * 
 * <p>
 * For example, exceptions that signal that a pdf file is corrupt should be
 * represented as presentable exceptions so that the user interface frontends
 * can present according texts.
 * </p>
 * 
 * @author wprinz
 */
public class PresentableException extends Exception
{

  /**
   * SVUID.
   */
  private static final long serialVersionUID = -102406558526000792L;
  
  protected int errorCode = -1;

  /**
   * @param message
   */
  public PresentableException(int errorCode, String message)
  {
    super(message);
    
    this.errorCode = errorCode;
  }

  /**
   * @param message
   * @param cause
   */
  public PresentableException(int errorCode, String message, Throwable cause)
  {
    super(message, cause);
    
    this.errorCode = errorCode;
  }

  /**
   * @param cause
   */
  public PresentableException(int errorCode, Throwable cause)
  {
    super(cause);
    
    this.errorCode = errorCode;
  }
  
  /**
   * Returns the error code of this exception.
   * @return Returns the error code of this exception.
   */
  public int getErrorCode ()
  {
    return this.errorCode;
  }

}