/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XPropertySetRegistry.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 08:11:35 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_XPropertySetRegistry_idl__
#define __com_sun_star_ucb_XPropertySetRegistry_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_ucb_XPersistentPropertySet_idl__
#include <com/sun/star/ucb/XPersistentPropertySet.idl>
#endif

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** A registry (storage medium) for persistent propertysets.

     @version  1.0
     @author   Kai Sommerfeld
     @see      XPersistentPropertySet
  */
published interface XPropertySetRegistry : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** creates a new or opens an existing propertyset in the registry.

        @param key
        The key to use for addressing the propertyset.

        @param create
        Indicates whether a new set shall be created in case there
        does not already exist one for the given key.

        @returns
        The propertyset.
      */
    com::sun::star::ucb::XPersistentPropertySet
    openPropertySet( [in] string key, [in] boolean create );

    //-------------------------------------------------------------------------
    /** removes a propertyset from the registry.

        @param key
        The key to use for addressing the propertyset.
      */
    [oneway] void removePropertySet( [in] string key );
};

//=============================================================================

}; }; }; };

#endif
