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