offapi/com/sun/star/script/XLibraryContainer2.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: XLibraryContainer2.idl,v $
  10  * $Revision: 1.5 $
  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_XLibraryContainer2_idl__
  31 #define __com_sun_star_script_XLibraryContainer2_idl__
  32
  33 #ifndef __com_sun_star_script_XLibraryContainer_idl__
  34 #include <com/sun/star/script/XLibraryContainer.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module script {
  41
  42 //=============================================================================
  43
  44 /**
  45     Extension of <type>XLibraryContainer</type> to provide additional information
  46     about the libraries contained in a library container
  47  */
  48 published interface XLibraryContainer2: com::sun::star::script::XLibraryContainer
  49 {
  50     /**
  51         returns true if the accessed library item is a link,
  52         e.g., created by createLibraryLink, otherwise false.
  53      */
  54     boolean isLibraryLink( [in] string Name )
  55             raises( com::sun::star::container::NoSuchElementException );
  56
  57     /**
  58         returns the location of the library link target.
  59         Should return the same URL that was passed to
  60         createLibraryLink in the StorageURL parameter.
  61
  62         If the accessed library item exists but isn't a
  63         link, a IllegalArgumentException is thrown
  64      */
  65     string getLibraryLinkURL( [in] string Name )
  66             raises( com::sun::star::lang::IllegalArgumentException,
  67                     com::sun::star::container::NoSuchElementException );
  68
  69     /**
  70         returns true if the accessed library item (library or library
  71         link) is read only. A library can be read only because it was
  72         set to read only using the methods provided by this interface
  73         or because of other reasons depending on the implementation
  74         (e.g., file system write protection)
  75      */
  76     boolean isLibraryReadOnly( [in] string Name )
  77             raises( com::sun::star::container::NoSuchElementException );
  78
  79     /**
  80         Sets the accessed library item (library or library link) to
  81         read only according to the flag bReadOnly (true means read only)
  82      */
  83     void setLibraryReadOnly( [in] string Name, [in] boolean bReadOnly )
  84             raises( com::sun::star::container::NoSuchElementException );
  85
  86     /** renames the library item with the specified name. If the accessed
  87         library item is a link only the link is renamed, not the target library.
  88         If a library with the new name exists already a
  89         com::sun::star::container::ElementExistException is thrown.
  90      */
  91     void renameLibrary( [in] string Name, [in] string NewName )
  92             raises( com::sun::star::container::NoSuchElementException,
  93                     com::sun::star::container::ElementExistException );
  94
  95 };
  96
  97 //=============================================================================
  98
  99
 100 }; }; }; };
 101
 102 #endif