DbSettings.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="DbSettings.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/string.h>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
namespace Connectivity
{
template <typename, typename> class DbMapper;
class DbReader;
class DbTypeConverter;
class MpdAssignmentBaselineMapper;
class MpdAssignmentMapper;
class MpdDateFieldMapper;
class MpdDurationFieldMapper;
class MpdExtendedAttributeDefinitionMapper;
class MpdFlagFieldMapper;
class MpdNumberFieldMapper;
class MpdOutlineCodeDefinitionMapper;
class MpdOutlineCodeFieldMapper;
class MpdProjectPropsMapper;
class MpdReader;
class MpdResourceBaselineMapper;
class MpdResourceMapper;
class MpdSettings;
class MpdTaskBaselineMapper;
class MpdTaskLinkMapper;
class MpdTaskMapper;
class MpdTextFieldMapper;
class MspAssignmentMapper;
class MspCalendarMapper;
class MspDbReader;
class MspDbSettings;
class MspProjectPropsMapper;
class MspResourceMapper;
class MspTaskLinksMapper;
class MspTaskMapper;
class PmCurrencyMapper;
class PmProjectTimeMapper;
class PmResourceMapper;
class PmResourceRateMapper;
class PmTaskMapper;
class PmTaskRelationMapper;
class PmWbsMapper;
class PrimaveraDbReader;
class PrimaveraDbSettings;
} // namespace Connectivity
class Project;
} // namespace Tasks
} // namespace Aspose
 
namespace Aspose {
 
namespace Tasks {
 
namespace Connectivity {
 
/// <summary>
/// Allows to specify settings to read from project database.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS DbSettings : public System::Object
{
    typedef DbSettings ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Project;
    template<typename FT0, typename FT1> friend class Aspose::Tasks::Connectivity::DbMapper;
    friend class Aspose::Tasks::Connectivity::MpdAssignmentBaselineMapper;
    friend class Aspose::Tasks::Connectivity::MpdAssignmentMapper;
    friend class Aspose::Tasks::Connectivity::MpdDateFieldMapper;
    friend class Aspose::Tasks::Connectivity::MpdDurationFieldMapper;
    friend class Aspose::Tasks::Connectivity::MpdExtendedAttributeDefinitionMapper;
    friend class Aspose::Tasks::Connectivity::MpdFlagFieldMapper;
    friend class Aspose::Tasks::Connectivity::MpdNumberFieldMapper;
    friend class Aspose::Tasks::Connectivity::MpdOutlineCodeDefinitionMapper;
    friend class Aspose::Tasks::Connectivity::MpdOutlineCodeFieldMapper;
    friend class Aspose::Tasks::Connectivity::MpdProjectPropsMapper;
    friend class Aspose::Tasks::Connectivity::MpdReader;
    friend class Aspose::Tasks::Connectivity::MpdResourceBaselineMapper;
    friend class Aspose::Tasks::Connectivity::MpdResourceMapper;
    friend class Aspose::Tasks::Connectivity::MpdSettings;
    friend class Aspose::Tasks::Connectivity::MpdTaskBaselineMapper;
    friend class Aspose::Tasks::Connectivity::MpdTaskLinkMapper;
    friend class Aspose::Tasks::Connectivity::MpdTaskMapper;
    friend class Aspose::Tasks::Connectivity::MpdTextFieldMapper;
    friend class Aspose::Tasks::Connectivity::MspDbSettings;
    friend class Aspose::Tasks::Connectivity::MspAssignmentMapper;
    friend class Aspose::Tasks::Connectivity::MspCalendarMapper;
    friend class Aspose::Tasks::Connectivity::MspDbReader;
    friend class Aspose::Tasks::Connectivity::MspProjectPropsMapper;
    friend class Aspose::Tasks::Connectivity::MspResourceMapper;
    friend class Aspose::Tasks::Connectivity::MspTaskLinksMapper;
    friend class Aspose::Tasks::Connectivity::MspTaskMapper;
    friend class Aspose::Tasks::Connectivity::PmCurrencyMapper;
    friend class Aspose::Tasks::Connectivity::PmProjectTimeMapper;
    friend class Aspose::Tasks::Connectivity::PmResourceMapper;
    friend class Aspose::Tasks::Connectivity::PmResourceRateMapper;
    friend class Aspose::Tasks::Connectivity::PmTaskMapper;
    friend class Aspose::Tasks::Connectivity::PmTaskRelationMapper;
    friend class Aspose::Tasks::Connectivity::PmWbsMapper;
    friend class Aspose::Tasks::Connectivity::PrimaveraDbReader;
    friend class Aspose::Tasks::Connectivity::PrimaveraDbSettings;
    
public:
 
    /// <summary>
    /// Gets the connection string.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_ConnectionString() const;
    /// <summary>
    /// Sets the connection string.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ConnectionString(const System::String& value);
    /// <summary>
    /// Gets provider invariant name which is used to get an instance of the <see cref="System::Data::Common::DbProviderFactory"></see> class.
    /// <remarks>Default value is <see cref="System::Data::SqlClient"></see>.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_ProviderInvariantName() const;
    /// <summary>
    /// Sets provider invariant name which is used to get an instance of the <see cref="System::Data::Common::DbProviderFactory"></see> class.
    /// <remarks>Default value is <see cref="System::Data::SqlClient"></see>.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ProviderInvariantName(const System::String& value);
    
protected:
 
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<Aspose::Tasks::Project>& get_Project() const;
    ASPOSE_TASKS_SHARED_API void set_Project(const System::SharedPtr<Aspose::Tasks::Project>& value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="DbSettings"></see> class.
    /// </summary>
    /// <param name="connectionString">the specified connection string.</param>
    ASPOSE_TASKS_SHARED_API DbSettings(const System::String& connectionString);
    
    virtual ASPOSE_TASKS_SHARED_API System::SharedPtr<DbReader> GetDbReader() = 0;
    virtual ASPOSE_TASKS_SHARED_API System::SharedPtr<DbTypeConverter> GetTypeConverter() = 0;
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::String pr_ConnectionString;
    System::String pr_ProviderInvariantName;
    System::WeakPtr<Aspose::Tasks::Project> pr_Project;
    
};
 
} // namespace Connectivity
} // namespace Tasks
} // namespace Aspose