offapi/com/sun/star/util/XCloseable.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
  21 module com {  module sun {  module star {  module util {
  22
  23 /** makes it possible to release any objects in an ordered manner by using
  24     a two-step mechanism
  25
  26     <p>
  27     If an object should be terminated, it can be:<br>
  28     <ul>
  29         <li>disposed (if it supports com::sun::star::lang::XComponent::dispose())</li>
  30         <li>closed   (if it supports XCloseable::close())</li>
  31     </ul>
  32     First version gives the object no chance to disagree with that (e.g. if a
  33     process is still running and can't be canceled really). Last version
  34     provides this possibility, but can't guarantee real termination of called object.
  35     It depends from the environment of an object, if one or both mechanism are necessary.
  36     </p>
  37
  38     <p>
  39     Base interface XCloseBroadcaster makes it possible that any listener
  40     which is interested on life time of listened object ...
  41     <ul>
  42         <li>can get a notification about closing of it</li>
  43         <li>or can have a veto to break that.</li>
  44     </ul>
  45     </p>
  46
  47     @see com::sun::star::lang::XComponent::dispose()
  48     @see XCloseBroadcaster
  49     @see XCloseListener
  50  */
  51 published interface XCloseable: XCloseBroadcaster
  52 {
  53     /** try to close the object
  54
  55         <p>
  56         Must definitely be called before com::sun::star::lang::XComponent::dispose().
  57         But nobody can guarantee real closing of called object - because it can disagree with that if any
  58         still running processes can't be canceled yet. It's not allowed to block this call till internal
  59         operations will be finished here. They must be canceled or call must return immediately by throwing
  60         the CloseVetoException.  Otherwise (if nothing exist to disagree) it must return normally.
  61         </p>
  62
  63         <p>
  64         Before any internal processes will be canceled, all registered XCloseListener
  65         must be notified. Any of them can disagree with a CloseVetoException too.
  66         It's forbidden to catch this exception inside the called close() method because the caller must
  67         get this information!
  68         </p>
  69
  70         <p>
  71         If somewhere disagree with a CloseVetoException it will not clear who has to close the object again
  72         after still running processes was finished. The parameter <var>DeliverOwnership</var> regulate that.
  73         If it is set to `FALSE` the caller of the method close() will be the owner of this object in every case.
  74         Then it's not allowed to call close() from any other place (may a registered XCloseListener).
  75         If it is set to `TRUE` the caller gives up his ownership. If a XCloseListener throw the veto exception
  76         he will be the new owner of the closing object. This information is passed to the listener by a parameter of
  77         his notification method XCloseListener::queryClosing(). After his operations was finished
  78         he MUST try to close it again. If the closing object itself disagree by an exception and the parameter
  79         <var>DeliverOwnership</var> was set to `TRUE` the object will be his own owner with all consequences of that.
  80         <br><strong>Note:</strong><br>
  81         There is no way to get the ownership back if it was delivered!
  82         </p>
  83
  84         <p>
  85         If this method was already called on an object it should return without any reaction. Normally it's possible to throw
  86         a com::sun::star::lang::DisposedException for already disposed or closed objects
  87         (which represent a com::sun::star::uno::RuntimeException and can be thrown by every interface call),
  88         but it shouldn't be used here. The veto exception should be the only way to indicates the result.
  89         </p>
  90
  91         @param DeliverOwnership
  92                 `TRUE` delegates the ownership of this closing object to anyone which throw the CloseVetoException.
  93                 This new owner has to close the closing object again if his still running processes will be finished.
  94                 <br>
  95                 `FALSE` let the ownership at the original one which called the close() method. He must react for possible
  96                 CloseVetoExceptions and try it again at a later time. This can be useful for a generic UI handling.
  97
  98         @throws CloseVetoException
  99             indicates that the closing object himself or any of his currently registered listener disagree with this close() request.
 100
 101         @see XCloseListener
 102         @see CloseVetoException
 103         @see com::sun::star::lang::XComponent::dispose()
 104         @see com::sun::star::lang::DisposedException
 105      */
 106     void close( [in] boolean DeliverOwnership )
 107             raises( CloseVetoException );
 108 };
 109
 110
 111 }; }; }; };
 112
 113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */