offapi/com/sun/star/task/XRestartManager.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_task_XRestartManager_idl__
  21 #define __com_sun_star_task_XRestartManager_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/task/XInteractionHandler.idl>
  25 #include <com/sun/star/uno/Exception.idl>
  26
  27
  28 module com {  module sun {  module star {  module task {
  29
  30 /** allows to try to restart the office.
  31
  32     @since OOo 3.3
  33 */
  34 published interface XRestartManager : com::sun::star::uno::XInterface
  35 {
  36     /** let the office restart asynchronously
  37         @param xInteractionHandler
  38             the com::sun::star::task::InteractionHandler
  39             service implementation, that is used in case a problem is detected
  40             during requesting the restart.
  41
  42         @throws com::sun::star::uno::Exception
  43             to notify the caller about possible failures
  44     */
  45     void requestRestart(
  46         [in] com::sun::star::task::XInteractionHandler xInteractionHandler )
  47             raises( com::sun::star::uno::Exception );
  48
  49     /** allows to get info whether the restart has been requested and provide
  50         the initialization status.
  51
  52         <p>
  53         The office has to call this method just before the main loop has been
  54         started, with the `TRUE` as argument, so that the implementation
  55         knows that the office is initialized. If the method returns `TRUE`,
  56         the office should restart without starting the main loop.
  57         </p>
  58
  59         @param bInitialized
  60             specifies whether the office process is initialized already,
  61             if the caller does not have this information, he should provide
  62             `FALSE`.
  63
  64         @returns
  65             `TRUE` if the office restart has been requested,
  66             `FALSE` otherwise
  67
  68         @throws com::sun::star::uno::Exception
  69             to notify the caller about possible failures
  70     */
  71     boolean isRestartRequested(
  72         [in] boolean bInitialized )
  73             raises( com::sun::star::uno::Exception );
  74 };
  75
  76 }; }; }; };
  77
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */