/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */



module com { module sun { module star { module registry {

/** allows access to a registry (a persistent data source).
    The data is stored in a hierarchical key structure beginning with a root key.
    Each key can store a value and can have multiple subkeys.

    @see XRegistryKey
*/
published interface XSimpleRegistry: com::sun::star::uno::XInterface
{
    /** returns the URL of the current data source of the registry.
     */
    string  getURL();

    /** connects the registry to a persistent data source represented by
        a URL.

        <p>If a local registry is already open, this function
        will close the currently open registry.

        @param rURL
        specifies the complete URL to access the data source.

        @param bReadOnly
        specifies if the data source should be opened for
        read only.

        @param bCreate
        specifies if the data source should be created if it
        does not already exist.

        @throws InvalidRegistryException
        if the registry does not exist.
    */
    void open( [in] string rURL,
             [in] boolean bReadOnly,
             [in] boolean bCreate )
            raises( com::sun::star::registry::InvalidRegistryException );

    /** checks if the registry points to a valid data-source.
    */
    boolean isValid();

    /** disconnects the registry from the data-source.

        @throws InvalidRegistryException
        if the registry is not open.
    */
    void close()
            raises( com::sun::star::registry::InvalidRegistryException );

    /** destroys the registry and the data source.

        @throws InvalidRegistryException
        if the registry is not open.
    */
    void destroy()
            raises( com::sun::star::registry::InvalidRegistryException );

    /** @returns
        the root key of the registry.

        @throws InvalidRegistryException
        if no registry is open
    */
    com::sun::star::registry::XRegistryKey getRootKey()
            raises( com::sun::star::registry::InvalidRegistryException );

    /** checks if the registry is readonly.

        @throws InvalidRegistryException
        if the registry is not open.
    */
    boolean isReadOnly()
            raises( com::sun::star::registry::InvalidRegistryException );

    /** merges a registry under the specified key.

        @deprecated The merge functionality is deprecated and not implemented.  Implementations will
        throw a com::sun::star::RuntimeException.
    */
    void mergeKey( [in] string aKeyName,
             [in] string aUrl )
            raises( com::sun::star::registry::InvalidRegistryException,
                    com::sun::star::registry::MergeConflictException );

};


}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */