offapi/com/sun/star/ucb/XPropertySetRegistry.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_XPropertySetRegistry_idl__
  28 #define __com_sun_star_ucb_XPropertySetRegistry_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_ucb_XPersistentPropertySet_idl__
  35 #include <com/sun/star/ucb/XPersistentPropertySet.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module ucb {
  41
  42 //=============================================================================
  43 /** A registry (storage medium) for persistent propertysets.
  44
  45      @version  1.0
  46      @author   Kai Sommerfeld
  47      @see      XPersistentPropertySet
  48   */
  49 published interface XPropertySetRegistry : com::sun::star::uno::XInterface
  50 {
  51     //-------------------------------------------------------------------------
  52     /** creates a new or opens an existing propertyset in the registry.
  53
  54         @param key
  55         The key to use for addressing the propertyset.
  56
  57         @param create
  58         Indicates whether a new set shall be created in case there
  59         does not already exist one for the given key.
  60
  61         @returns
  62         The propertyset.
  63       */
  64     com::sun::star::ucb::XPersistentPropertySet
  65     openPropertySet( [in] string key, [in] boolean create );
  66
  67     //-------------------------------------------------------------------------
  68     /** removes a propertyset from the registry.
  69
  70         @param key
  71         The key to use for addressing the propertyset.
  72       */
  73     [oneway] void removePropertySet( [in] string key );
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif