/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


package com.sun.star.wizards.web;

import com.sun.star.awt.VclWindowPeerAttribute;

/**
 * @author rpiterman
 *
 * To change the template for this generated type comment go to
 * Window>Preferences>Java>Code Generation>Code and Comments
 */
public interface ErrorHandler
{

    public static final String MESSAGE_INFO = "infobox";
    public static final String MESSAGE_QUESTION = "querybox";
    public static final String MESSAGE_ERROR = "errorbox";
    public static final String MESSAGE_WARNING = "warningbox";
    public static int BUTTONS_OK = VclWindowPeerAttribute.OK;
    public static int BUTTONS_OK_CANCEL = VclWindowPeerAttribute.OK_CANCEL;
    public static int BUTTONS_YES_NO = VclWindowPeerAttribute.YES_NO;
    public static int RESULT_CANCEL = 0;
    public static int RESULT_OK = 1;
    public static int RESULT_YES = 2;
    public static int DEF_OK = VclWindowPeerAttribute.DEF_OK;
    public static int DEF_CANCEL = VclWindowPeerAttribute.DEF_CANCEL;
    public static int DEF_YES = VclWindowPeerAttribute.DEF_YES;
    public static int DEF_NO = VclWindowPeerAttribute.DEF_NO;
    /**
     * Error type for fatal errors which should abort application 
     * execution. Should actually never be used :-)
     */
    public static final int ERROR_FATAL = 0;
    /**
     * An Error type for errors which should stop the current process.
     */
    public static final int ERROR_PROCESS_FATAL = 1;
    /**
     * An Error type for errors to which the user can choose, whether
     * to continue or to abort the current process.
     * default is abort.
     */
    public static final int ERROR_NORMAL_ABORT = 2;
    /**
     * An Error type for errors to which the user can choose, whether
     * to continue or to abort the current process.
     * default is continue.
     */
    public static final int ERROR_NORMAL_IGNORE = 3;
    /**
     * An error type for warnings which requires user interaction.
     * (a question :-) )
     * Default is abort (cancel).
     */
    public static final int ERROR_QUESTION_CANCEL = 4;
    /**
     * An error type for warnings which requires user interaction
     * (a question :-) )
     * Default is to continue (ok).
     */
    public static final int ERROR_QUESTION_OK = 5;
    /**
     * An error type for warnings which requires user interaction.
     * (a question :-) )
     * Default is abort (No).
     */
    public static final int ERROR_QUESTION_NO = 6;
    /**
     * An error type for warnings which requires user interaction
     * (a question :-) )
     * Default is to continue (Yes).
     */
    public static final int ERROR_QUESTION_YES = 7;
    /**
     * An error type which is just a warning...
     */
    public static final int ERROR_WARNING = 8;
    /**
     * An error type which just tells the user something 
     * ( like "you look tired! you should take a bath! and so on)
     */
    public static final int ERROR_MESSAGE = 9;

    /**
     * @param ex the exception that accured
     * @param arg an object as help for recognizing the exception
     * @param ix an integer which helps for detailed recognizing of the exception
     * @param errorType one of the int constants defined by this Interface
     * @return true if the execution should continue, false if it should stop.
     */
    public boolean error(Exception ex, Object arg, int ix, int errorType);
}
