offapi/com/sun/star/ucb/XCommandProcessor2.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XCommandProcessor2.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_ucb_XCommandProcessor2_idl__
  32 #define __com_sun_star_ucb_XCommandProcessor2_idl__
  33
  34 #ifndef __com_sun_star_ucb_XCommandProcessor_idl__
  35 #include <com/sun/star/ucb/XCommandProcessor.idl>
  36 #endif
  37
  38 module com { module sun { module star { module ucb {
  39
  40 //============================================================================
  41 /** An improved version of a
  42     <type scope="com::sun::star::ucb">XCommandProcessor</type> that helps avoid
  43     ever-increasing resource consumption.
  44  */
  45 published interface XCommandProcessor2: com::sun::star::ucb::XCommandProcessor
  46 {
  47     //------------------------------------------------------------------------
  48     /** releases a command identifier obtainded through
  49         <member>XCommandProcessor::createCommandIdentifier</member> when it is
  50         no longer used.
  51
  52         <p>After this call the command identifier cannot be used any longer in
  53         calls to <member>XCommandProcessor::execute</member> and
  54         <member>XCommandProcessor::abort</member>.  (But it can happen that a
  55         call to <member>XCommandProcessor::createCommandIdentifier</member>
  56         reuses this identifier.)</p>
  57
  58         @param CommandId
  59         A command identifier obtained through
  60         <member>XCommandProcessor::createCommandIdentifier</member>.  If the
  61         identifier is zero, the request is silently ignored; but if the
  62         identifier is invalid (not obtained via
  63         <member>XCommandProcessor::createCommandIdentifier</member> or already
  64         handed to <member>XCommandProcessor2::releaseCommandIdentifier</member>
  65         before), the behaviour is undefined.
  66      */
  67     [oneway] void releaseCommandIdentifier([in] long CommandId);
  68 };
  69
  70 }; }; }; };
  71
  72 #endif