datasourcehandling.hxx

Go to the documentation of this file.

/* -*- 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 .
 */
 
#pragma once
 
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <memory>
 
#include "abptypes.hxx"
 
 
namespace com::sun::star {
    namespace beans {
        class XPropertySet;
    }
}
 
namespace weld { class Window; }
 
 
namespace abp
{
 
    struct ODataSourceContextImpl;
    class ODataSource;
    class ODataSourceContext
    {
    private:
        std::unique_ptr<ODataSourceContextImpl>   m_pImpl;
 
    public:
        explicit ODataSourceContext(
            const css::uno::Reference< css::uno::XComponentContext >& _rxORB
        );
        ~ODataSourceContext();
 
        void    getDataSourceNames( StringBag& _rNames ) const;
 
        void disambiguate(OUString& _rDataSourceName);
 
        ODataSource createNewThunderbird( const OUString& _rName );
 
        ODataSource createNewEvolution( const OUString& _rName );
 
        ODataSource createNewEvolutionLdap( const OUString& _rName );
 
        ODataSource createNewEvolutionGroupwise( const OUString& _rName );
 
        ODataSource createNewKab( const OUString& _rName );
 
        ODataSource createNewMacab( const OUString& _rName );
 
        ODataSource createNewOther( const OUString& _rName );
    };
 
    struct ODataSourceImpl;
    struct AddressSettings;
    class ODataSource
    {
    private:
        std::unique_ptr<ODataSourceImpl>    m_pImpl;
 
    public:
 
        // - ctor/dtor/assignment
 
        explicit ODataSource(
            const css::uno::Reference< css::uno::XComponentContext >& _rxORB
        );
 
        ODataSource( const ODataSource& _rSource );
 
        ~ODataSource( );
 
        ODataSource& operator=( const ODataSource& _rSource );
 
        ODataSource& operator=(ODataSource&& _rSource) noexcept;
 
        bool    isValid() const;
 
 
        void        remove();
            // TODO: put this into the context class
 
        OUString
                    getName() const;
 
        bool    rename( const OUString& _rName );
            // TODO: put this into the context class
 
 
        // - connection handling
 
        bool    connect(weld::Window* _pMessageParent);
 
        bool    isConnected( ) const;
 
        void        disconnect( );
 
        void        store(const AddressSettings& rSettings);
 
        void        registerDataSource( const OUString& _sRegisteredDataSourceName );
 
 
        const StringBag&    getTableNames() const;
 
        bool    hasTable( const OUString& _rTableName ) const;
 
        css::uno::Reference< css::beans::XPropertySet > getDataSource() const;
 
 
        void        setDataSource(
             const css::uno::Reference< css::beans::XPropertySet >& _rxDS
            ,const OUString& _sName
        );
    };
 
 
}   // namespace abp
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */