/*************************************************************************
 *
 * 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_task_XRestartManager_idl__
#define __com_sun_star_task_XRestartManager_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_task_XInteractionHandler_idl__
#include <com/sun/star/task/XInteractionHandler.idl>
#endif

#ifndef __com_sun_star_uno_Exception_idl__
#include <com/sun/star/uno/Exception.idl>
#endif

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

module com {  module sun {  module star {  module task {

//=============================================================================
/** allows to try to restart the office.

    @since OOo 3.3
*/
published interface XRestartManager : com::sun::star::uno::XInterface
{
    //------------------------------------------------------------------------
    /** let the office restart asynchronously
        @param xInteractionHandler
            the <type scope="com::sun::star::task">InteractionHandler</type>
            service implementation, that is used in case a problem is detected
            during requesting the restart.

        @throws com::sun::star::uno::Exception
            to notify the caller about possible failures
    */
    void requestRestart(
        [in] com::sun::star::task::XInteractionHandler xInteractionHandler )
            raises( com::sun::star::uno::Exception );

    //------------------------------------------------------------------------
    /** allows to get info whether the restart has been requested and provide
        the initialization status.

        <p>
        The office has to call this method just before the main loop has been
        started, with the <TRUE/> as argument, so that the implementation
        knows that the office is initialized. If the method returns <TRUE/>,
        the office should restart without starting the main loop.
        </p>

        @param bInitialized
            specifies whether the office process is initialized already,
            if the caller does not have this information, he should provide
            <FALSE/>.

        @returns
            <TRUE/> if the office restart has been requested,
            <FALSE/> otherwise

        @throws com::sun::star::uno::Exception
            to notify the caller about possible failures
    */
    boolean isRestartRequested(
        [in] boolean bInitialized )
            raises( com::sun::star::uno::Exception );
};

}; }; }; };

#endif

