/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_ucb_XCommandEnvironment_idl__
#define __com_sun_star_ucb_XCommandEnvironment_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/task/XInteractionHandler.idl>
#include <com/sun/star/ucb/XProgressHandler.idl>

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** defines the environment for a command.

    @version  1.0
    @author   Kai Sommerfeld
    @see XCommandProcessor
*/
published interface XCommandEnvironment : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** returns the command's interaction handler.

        <p>If called multiple times, this method should consistently return the
        same value (to allow caching).

        @returns
        an interaction handler
    */
    com::sun::star::task::XInteractionHandler getInteractionHandler();

    //-------------------------------------------------------------------------
    /** returns the command's progress handler.

        <p>If called multiple times, this method should consistently return the
        same value (to allow caching).

        @returns
        a progress handler
    */
    com::sun::star::ucb::XProgressHandler getProgressHandler();
};

//=============================================================================

}; }; }; };

#endif