offapi/com/sun/star/script/XLibraryContainer.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: XLibraryContainer.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_XLibraryContainer_idl__
  31 #define __com_sun_star_script_XLibraryContainer_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_XNameContainer_idl__
  38 #include <com/sun/star/container/XNameContainer.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  42 #include <com/sun/star/lang/IllegalArgumentException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  46 #include <com/sun/star/container/NoSuchElementException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_container_ElementExistException_idl__
  50 #include <com/sun/star/container/ElementExistException.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  54 #include <com/sun/star/lang/WrappedTargetException.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_container_ElementExistException_idl__
  58 #include <com/sun/star/container/ElementExistException.idl>
  59 #endif
  60 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  61 #include <com/sun/star/lang/WrappedTargetException.idl>
  62 #endif
  63
  64
  65 //=============================================================================
  66
  67 module com {  module sun {  module star {  module script {
  68
  69 //=============================================================================
  70
  71 /**
  72     Provides access to a library system.
  73  */
  74 published interface XLibraryContainer: com::sun::star::container::XNameAccess
  75 {
  76     /**
  77         Creates a new library
  78      */
  79     com::sun::star::container::XNameContainer createLibrary( [in] string Name )
  80         raises( com::sun::star::lang::IllegalArgumentException,
  81                 com::sun::star::container::ElementExistException );
  82
  83     /**
  84         Creates a link to an "external" library that then can be
  85         accessed using this library manager. The format of the
  86         StorageURL is a matter of the implementation. If the read
  87         only flag is set, the linked library cannot be modified.
  88         In this case, the returned interface really is only an
  89         XNameAccess. If ReadOnly is false (and the referenced
  90         storage allows write access) the returned interface also
  91         can be a <type scope="com::sun::star::container">XNameContainer</type>.
  92      */
  93     com::sun::star::container::XNameAccess createLibraryLink( [in] string Name, [in] string StorageURL, [in] boolean ReadOnly )
  94         raises( com::sun::star::lang::IllegalArgumentException,
  95                 com::sun::star::container::ElementExistException );
  96
  97     /** removes the library item with the specified name. If the accessed
  98         library item is a link only the link is removed, not the target library.
  99      */
 100     void removeLibrary( [in] string Name )
 101             raises( com::sun::star::container::NoSuchElementException,
 102                     com::sun::star::lang::WrappedTargetException );
 103
 104     /**
 105         returns true if the accessed library is already loaded from
 106         the storage, otherwise false.
 107      */
 108     boolean isLibraryLoaded( [in] string Name )
 109             raises( com::sun::star::container::NoSuchElementException );
 110
 111     /**
 112         Causes the accessed library to be loaded from its storage
 113         if it hasn't already been loaded.
 114      */
 115     void loadLibrary( [in] string Name )
 116             raises( com::sun::star::container::NoSuchElementException,
 117                     com::sun::star::lang::WrappedTargetException );
 118
 119 };
 120
 121 //=============================================================================
 122
 123
 124 }; }; }; };
 125
 126 #endif