OutlineCodeDefinition.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="OutlineCodeDefinition.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------

#include <system/string.h>
#include <system/collections/icomparer.h>

#include "aspose.tasks.cpp/NullableBool.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"

namespace Aspose
{
namespace Tasks
{
namespace Connectivity
{
class MpdOutlineCodeDefinitionMapper;
} // namespace Connectivity
class ExtendedAttributeDefinition;
namespace IO
{
namespace MSProject
{
class CustomFieldTypeReader;
class MPP12OutlineCodeDefinitionReader;
class MPP12Reader;
class MPP14OutlineCodeDefinitionReader;
class MPP14Reader;
class MPP9OutlineCodeDefinitionReader;
class MPP9OutlineCodeDefinitionWriter;
class MPPOutlineCodeDefinitionWriter;
} // namespace MSProject
namespace PrimaveraXml
{
class PrimaveraActivityCodeValueNodeReader;
} // namespace PrimaveraXml
namespace Pwa
{
namespace InternalApi
{
namespace Mapping
{
class ExtendedAttributeDefinitionMapper;
class ExtendedAttributeDefinitionToRawValuesMapper;
} // namespace Mapping
} // namespace InternalApi
} // namespace Pwa
namespace Xer
{
class PrimaveraExtendedAttributeLookupBuilder;
} // namespace Xer
namespace Xml
{
class ExtendedAttributeNodeReader;
class OutlineCodeDefinitionReader;
class OutlineCodeDefinitionXml;
class XmlReader;
class XmlWriter;
} // namespace Xml
} // namespace IO
class OutlineCode;
class OutlineCodesSynchronizer;
class OutlineMaskCollection;
class OutlineValueCollection;
class Project;
namespace Visualization
{
template <typename> class FieldToColumnText;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose

namespace Aspose {

namespace Tasks {

/// <summary>
/// Represents an outline code definition.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS OutlineCodeDefinition : public System::Object
{
    typedef OutlineCodeDefinition ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::IO::PrimaveraXml::PrimaveraActivityCodeValueNodeReader;
    friend class Aspose::Tasks::IO::Xer::PrimaveraExtendedAttributeLookupBuilder;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ExtendedAttributeDefinitionToRawValuesMapper;
    friend class Aspose::Tasks::Connectivity::MpdOutlineCodeDefinitionMapper;
    friend class Aspose::Tasks::IO::MSProject::CustomFieldTypeReader;
    friend class Aspose::Tasks::IO::MSProject::MPP12Reader;
    friend class Aspose::Tasks::IO::MSProject::MPP14OutlineCodeDefinitionReader;
    friend class Aspose::Tasks::IO::MSProject::MPP14Reader;
    friend class Aspose::Tasks::IO::MSProject::MPPOutlineCodeDefinitionWriter;
    friend class Aspose::Tasks::IO::MSProject::MPP9OutlineCodeDefinitionWriter;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ExtendedAttributeDefinitionMapper;
    friend class Aspose::Tasks::IO::Xml::ExtendedAttributeNodeReader;
    friend class Aspose::Tasks::IO::Xml::OutlineCodeDefinitionReader;
    friend class Aspose::Tasks::IO::Xml::OutlineCodeDefinitionXml;
    friend class Aspose::Tasks::IO::Xml::XmlReader;
    friend class Aspose::Tasks::IO::Xml::XmlWriter;
    friend class Aspose::Tasks::OutlineCode;
    friend class Aspose::Tasks::OutlineCodesSynchronizer;
    template<typename FT0> friend class Aspose::Tasks::Visualization::FieldToColumnText;
    friend class Aspose::Tasks::IO::MSProject::MPP9OutlineCodeDefinitionReader;
    friend class Aspose::Tasks::IO::MSProject::MPP12OutlineCodeDefinitionReader;
    
protected:

    class ASPOSE_TASKS_SHARED_CLASS OutlineCodeDefComparer : public System::Collections::Generic::IComparer<System::SharedPtr<Aspose::Tasks::OutlineCodeDefinition>>
    {
        typedef OutlineCodeDefComparer ThisType;
        typedef System::Collections::Generic::IComparer<System::SharedPtr<Aspose::Tasks::OutlineCodeDefinition>> BaseType;
        
        typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
        ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
        
    public:
    
        ASPOSE_TASKS_SHARED_API int32_t Compare(const System::SharedPtr<OutlineCodeDefinition>& x, const System::SharedPtr<OutlineCodeDefinition>& y) const override;
        
    };
    
    
public:

    /// <summary>
    /// Gets the Guid of an outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Guid() const;
    /// <summary>
    /// Sets the Guid of an outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Guid(const System::String& value);
    /// <summary>
    /// Gets the field number of an outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_FieldId() const;
    /// <summary>
    /// Sets the field number of an outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FieldId(const System::String& value);
    /// <summary>
    /// Gets the name of a custom outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_FieldName() const;
    /// <summary>
    /// Sets the name of a custom outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FieldName(const System::String& value);
    /// <summary>
    /// Gets the alias of a custom outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Alias() const;
    /// <summary>
    /// Sets the alias of a custom outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Alias(const System::String& value);
    /// <summary>
    /// Gets the phonetic pronunciation of the alias of the custom outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_PhoneticAlias() const;
    /// <summary>
    /// Sets the phonetic pronunciation of the alias of the custom outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_PhoneticAlias(const System::String& value);
    /// <summary>
    /// Gets OutlineValueCollection object.
    /// The values of the table associated with this outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<OutlineValueCollection> get_Values() const;
    /// <summary>
    /// Gets a value indicating whether a custom outline code is an enterprise custom outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_Enterprise() const;
    /// <summary>
    /// Sets a value indicating whether a custom outline code is an enterprise custom outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Enterprise(bool value);
    /// <summary>
    /// Gets  a reference to another custom field for which this outline code definition is an alias.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_EnterpriseOutlineCodeAlias() const;
    /// <summary>
    /// Sets  a reference to another custom field for which this outline code definition is an alias.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_EnterpriseOutlineCodeAlias(int32_t value);
    /// <summary>
    /// Gets a value indicating whether the custom outline code can be used
    /// by the Resource Substitution Wizard in Microsoft Project.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_ResourceSubstitutionEnabled() const;
    /// <summary>
    /// Sets a value indicating whether the custom outline code can be used
    /// by the Resource Substitution Wizard in Microsoft Project.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ResourceSubstitutionEnabled(bool value);
    /// <summary>
    /// Gets a value indicating whether the values specified in this outline code field must be leaf values.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_LeafOnly() const;
    /// <summary>
    /// Sets a value indicating whether the values specified in this outline code field must be leaf values.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_LeafOnly(bool value);
    /// <summary>
    /// Gets a value indicating whether the new codes must have all levels.
    /// Not available for Enterprise Codes.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_AllLevelsRequired() const;
    /// <summary>
    /// Sets a value indicating whether the new codes must have all levels.
    /// Not available for Enterprise Codes.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_AllLevelsRequired(bool value);
    /// <summary>
    /// Gets a value indicating whether the values specified must come from values table.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_OnlyTableValuesAllowed() const;
    /// <summary>
    /// Sets a value indicating whether the values specified must come from values table.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_OnlyTableValuesAllowed(bool value);
    /// <summary>
    /// Gets the OutlineMaskCollection object.
    /// The table of entries that define the outline code mask.
    /// Read-only <see cref="OutlineMaskCollection"></see> instance.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<OutlineMaskCollection>& get_Masks() const;
    /// <summary>
    /// Gets a value indicating whether the indents of this outline code must be shown.
    /// </summary>
    /// <remarks>This is new for MS Project 2010 property.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API bool get_ShowIndent();
    /// <summary>
    /// Sets a value indicating whether the indents of this outline code must be shown.
    /// </summary>
    /// <remarks>This is new for MS Project 2010 property.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API void set_ShowIndent(bool value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="OutlineCodeDefinition"></see> class. 
    /// </summary>
    ASPOSE_TASKS_SHARED_API OutlineCodeDefinition();
    
protected:

    /// <summary>
    /// Gets OutlineValueCollection object.
    /// The values of the table associated with this outline code.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Values(const System::SharedPtr<OutlineValueCollection>& value);
    /// <summary>
    /// Gets the OutlineMaskCollection object.
    /// The table of entries that define the outline code mask.
    /// Read-only <see cref="OutlineMaskCollection"></see> instance.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Masks(const System::SharedPtr<OutlineMaskCollection>& value);
    ASPOSE_TASKS_SHARED_API NullableBool get_NullableShowIndent() const;
    ASPOSE_TASKS_SHARED_API void set_NullableShowIndent(NullableBool value);
    
    static ASPOSE_TASKS_SHARED_API void CopyFromOutlineCode(const System::SharedPtr<Project>& project, const System::SharedPtr<ExtendedAttributeDefinition>& attr);
    ASPOSE_TASKS_SHARED_API System::String GetOutlineValuesDisplayText(int32_t valueId);
    static ASPOSE_TASKS_SHARED_API void FixCostValues(const System::SharedPtr<Project>& project, const System::SharedPtr<ExtendedAttributeDefinition>& attr);
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:

    System::SharedPtr<OutlineValueCollection> values;
    NullableBool showIndent;
    System::String pr_Guid;
    System::String pr_FieldId;
    System::String pr_FieldName;
    System::String pr_Alias;
    System::String pr_PhoneticAlias;
    bool pr_Enterprise;
    int32_t pr_EnterpriseOutlineCodeAlias;
    bool pr_ResourceSubstitutionEnabled;
    bool pr_LeafOnly;
    bool pr_AllLevelsRequired;
    bool pr_OnlyTableValuesAllowed;
    System::SharedPtr<OutlineMaskCollection> pr_Masks;
    
    static System::SharedPtr<OutlineCodeDefinition> GetOutlineCode(const System::SharedPtr<Project>& project, const System::SharedPtr<ExtendedAttributeDefinition>& attr);
    
};

} // namespace Tasks
} // namespace Aspose