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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_ucb_XPersistentPropertySet_idl__
  28 #define __com_sun_star_ucb_XPersistentPropertySet_idl__
  29
  30 #ifndef __com_sun_star_beans_XPropertySet_idl__
  31 #include <com/sun/star/beans/XPropertySet.idl>
  32 #endif
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module ucb {
  37
  38 // forward.
  39  published interface XPropertySetRegistry;
  40
  41 //=============================================================================
  42 /** A persistent propertyset, which can be saved in and restored from a
  43     <type>XPropertySetRegistry</type>.
  44
  45      @version  1.0
  46      @author   Kai Sommerfeld
  47   */
  48 published interface XPersistentPropertySet : com::sun::star::beans::XPropertySet
  49 {
  50     //-------------------------------------------------------------------------
  51     /** returns the registry used to store the property set.
  52
  53         @returns
  54         The registry.
  55       */
  56     com::sun::star::ucb::XPropertySetRegistry getRegistry();
  57
  58     //-------------------------------------------------------------------------
  59     /** returns the key used to address the set in the propertyset registry.
  60
  61         @returns
  62         The key.
  63       */
  64     string getKey();
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif