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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module ucb {
  22
  23 /** A registry (storage medium) for persistent property sets.
  24
  25      @version  1.0
  26      @see      XPersistentPropertySet
  27   */
  28 published interface XPropertySetRegistry : com::sun::star::uno::XInterface
  29 {
  30     /** creates a new or opens an existing property set in the registry.
  31
  32         @param key
  33         The key to use for addressing the property set.
  34
  35         @param create
  36         Indicates whether a new set shall be created in case there
  37         does not already exist one for the given key.
  38
  39         @returns
  40         The property set.
  41       */
  42     com::sun::star::ucb::XPersistentPropertySet
  43     openPropertySet( [in] string key, [in] boolean create );
  44
  45     /** removes a property set from the registry.
  46
  47         @param key
  48         The key to use for addressing the property set.
  49       */
  50     void removePropertySet( [in] string key );
  51 };
  52
  53
  54 }; }; }; };
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */