offapi/com/sun/star/script/XPersistentLibraryContainer.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: XPersistentLibraryContainer.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
  31 #ifndef __com_sun_star_script_XPersistentLibraryContainer_idl__
  32 #define __com_sun_star_script_XPersistentLibraryContainer_idl__
  33
  34 #ifndef __com_sun_star_util_XModifiable_idl__
  35 #include <com/sun/star/util/XModifiable.idl>
  36 #endif
  37 #ifndef __com_sun_star_script_XLibraryContainer2_idl__
  38 #include <com/sun/star/script/XLibraryContainer2.idl>
  39 #endif
  40 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  41 #include <com/sun/star/lang/WrappedTargetException.idl>
  42 #endif
  43
  44 //=============================================================================
  45
  46 module com { module sun { module star { module script {
  47
  48 //=============================================================================
  49
  50 /** describes a container of script libraries which is persistent.
  51
  52     <p>The type of persistence of the container elements is not defined here,
  53     but in derived interfaces or services using
  54     <code>XPersistentLibraryContainer</code>.</p>
  55
  56     <p>The actual libraries are stored in some object - a sub folder, or a sub storage,
  57     for example - below the root location.</p>
  58
  59     @since OOo 2.3
  60  */
  61 interface XPersistentLibraryContainer
  62 {
  63     interface ::com::sun::star::util::XModifiable;
  64     interface XLibraryContainer2;
  65
  66     /** denotes the root location associated with the container.
  67
  68         <p>The type of this location - it might be a folder in a file system,
  69         a storage, or anything else - is not specified here, but in derived interfaces
  70         or services implementing <code>XPersistentLibraryContainer</code>.</p>
  71
  72         <p>All operations of the library container take place in a location below
  73         the root location, the so-called container location, whose
  74         name is exposed as <member>ContainerLocationName</member>.</p>
  75
  76         @see ContainerLocationName
  77     */
  78     [attribute, readonly] any   RootLocation;
  79
  80     /** denotes the name of the sub location where the container elements are
  81         actually stored.
  82
  83         @see RootLocation
  84     */
  85     [attribute, readonly] string ContainerLocationName;
  86
  87     /** stores the libraries to the current location.
  88
  89         @throws ::com::sun::star::lang::WrappedTargetException
  90             if an error occurs during storing.
  91
  92         @see RootLocation
  93         @see ContainerLocationName
  94     */
  95     void    storeLibraries()
  96         raises ( ::com::sun::star::lang::WrappedTargetException );
  97
  98 };
  99
 100 //=============================================================================
 101
 102 }; }; }; };
 103
 104 //=============================================================================
 105
 106 #endif
 107