/*******************************************************************************
 * Copyright (c) 2005, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 * Port to the D programming language:
 *     Frank Benoit <benoit@tionex.de>
 *******************************************************************************/

module dwtx.core.commands.IExecutionListenerWithChecks;

import dwtx.core.commands.common.NotDefinedException;
import dwtx.core.commands.IExecutionListener;
import dwtx.core.commands.NotEnabledException;

import dwt.dwthelper.utils;

/**
 * <p>
 * A listener to the execution of commands. This listener will be notified if
 * someone tries to execute a command and it is not enabled or not defined. The
 * listener also be notified if a command is about to execute, and when that
 * execution completes. It is not possible for the listener to prevent the
 * execution, only to respond to it in some way.
 * </p>
 * <p>
 * Clients may implement, but must not extend.
 * </p>
 *
 * @since 3.2
 */
public interface IExecutionListenerWithChecks : IExecutionListener {

    /**
     * Notifies the listener that an attempt was made to execute a command that
     * is not defined.
     *
     * @param commandId
     *            The identifier of command that is not defined; never
     *            <code>null</code>
     * @param exception
     *            The exception that occurred; never <code>null</code>.
     */
    public void notDefined(String commandId, NotDefinedException exception);

    /**
     * Notifies the listener that an attempt was made to execute a command that
     * is disabled.
     *
     * @param commandId
     *            The identifier of command that is not enabled; never
     *            <code>null</code>
     * @param exception
     *            The exception that occurred; never <code>null</code>.
     */
    public void notEnabled(String commandId, NotEnabledException exception);
}