offapi/com/sun/star/script/XLibraryContainerExport.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: XLibraryContainerExport.idl,v $
  10  * $Revision: 1.4 $
  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 #ifndef __com_sun_star_script_XLibraryContainerExport_idl__
  31 #define __com_sun_star_script_XLibraryContainerExport_idl__
  32
  33 #ifndef __com_sun_star_task_XInteractionHandler_idl__
  34 #include <com/sun/star/task/XInteractionHandler.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_uno_XInterface_idl__
  38 #include <com/sun/star/uno/XInterface.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  42 #include <com/sun/star/container/NoSuchElementException.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module script {
  49
  50 //=============================================================================
  51
  52 /**
  53     Extension of XLibraryContainer to provide functionality to
  54     store a library to a location represented by a URL.
  55  */
  56 interface XLibraryContainerExport : com::sun::star::uno::XInterface
  57 {
  58     /**
  59         Exports a library specified by Name to the location
  60         specified by the passed URL string.
  61
  62         An interaction handler can be passed to be used for internal
  63         ucb operations. Exceptions not processed by this handler will
  64         be passed as com::sun::star::uno::Exception. If this parameter
  65         is null this applies to all exceptions thrown by ucb.
  66
  67         @see com::sun::star::task::InteractionHandler
  68
  69         If a library with the this name doesn't exist a
  70         com::sun::star::container::NoSuchElementException is thrown.
  71      */
  72     void exportLibrary( [in] string Name, [in] string URL,
  73         [in] com::sun::star::task::XInteractionHandler Handler )
  74             raises( com::sun::star::uno::Exception,
  75                     com::sun::star::container::NoSuchElementException );
  76 };
  77
  78 //=============================================================================
  79
  80
  81 }; }; }; };
  82
  83 #endif