ExtendedAttribute.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="ExtendedAttribute.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/string.h>
#include <system/decimal.h>
#include <system/date_time.h>
 
#include "aspose.tasks.cpp/Duration.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
namespace Connectivity
{
template <typename> class MpdField;
class MspExtendedAttribute;
class MspTaskExtendedAttributeReader;
} // namespace Connectivity
enum class CustomFieldType;
class ExtendedAttributeCollection;
class ExtendedAttributeDefinition;
namespace Filters
{
class ExtendedAttributeIdFilter;
} // namespace Filters
class FormulaCalculator;
class FormulaOperatorToken;
class FormulaRelationalOperator;
class IExtendedAttributeParent;
namespace IO
{
namespace Html
{
class HtmlReadingUtils;
} // namespace Html
namespace Mpx
{
class MpxUtils;
} // namespace Mpx
namespace MSProject
{
class CustomFieldTypeReader;
class ExtendedAttributeValueConverter;
class MPP12AssignmentExtendedAttributeReader;
class MPP12AssignmentExtendedAttributeWriter;
class MPP12ExtendedAttributeWriter;
class MPP12ResourceWriter;
class MPP12TaskWriter;
class MPP14ResourceWriter;
class MPP14TaskWriter;
class MPP9AssignmentExtendedAttributeWriter;
class MPP9ResourceWriter;
class MPPAssignmentExtendedAttributeReader;
class MPPAssignmentExtendedAttributeWriter;
class MPPExtendedAttributeReader;
namespace Writers
{
class MPP9TaskWriter;
} // namespace Writers
} // namespace MSProject
namespace Pwa
{
namespace InternalApi
{
class CustomFieldContainerWriter;
namespace Mapping
{
class ExtendedAttributeDefinitionToRawValuesMapper;
template <typename> class ExtendedAttributeParentEntityToRawValuesMapper;
template <typename> class ProjectCoreEntityMapperBase;
} // namespace Mapping
} // namespace InternalApi
} // namespace Pwa
namespace Xer
{
class PrimaveraExtendedAttributeBuilder;
} // namespace Xer
namespace Xml
{
class ExtendedAttributeFactory;
class ExtendedAttributeNodeReader;
class ExtendedAttributeNodeWriter;
class ResourceAssignmentNodeReader;
class ResourceAssignmentNodeWriter;
} // namespace Xml
} // namespace IO
class ProjectIntegrityValidator;
namespace Rollup
{
class AverageFirstSublevelRollupCalculator;
class AverageRollupCalculator;
class ChildrenCountFirstSublevelRollupCalculator;
class ChildrenCountNonSummariesRollupCalculator;
class ChildrenCountRollupCalculator;
class DurationExtendedAttributeComparer;
class MinMaxRollupCalculator;
template <typename> class RollupCalculatorBase;
class SumRollupCalculator;
} // namespace Rollup
namespace Saving
{
class HtmlUtils;
class MpxSavingUtils;
} // namespace Saving
namespace Util
{
class ExtendedAttributeChecker;
namespace Fields
{
class FieldHelperInternal;
} // namespace Fields
} // namespace Util
namespace Visualization
{
template <typename> class FieldToColumnText;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents extended attributes.
/// </summary>
/// <remarks>
/// Currently supported all types of Extended attributes reading from MSP Xml 2003/2007 and mpp 2003.
/// For MSP mpp 2007 all Extended attributes reading supported except durations and flags.
/// </remarks>
class ASPOSE_TASKS_SHARED_CLASS ExtendedAttribute : public System::Object
{
    typedef ExtendedAttribute ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Filters::ExtendedAttributeIdFilter;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::CustomFieldContainerWriter;
    template<typename FT0> friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ExtendedAttributeParentEntityToRawValuesMapper;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ExtendedAttributeDefinitionToRawValuesMapper;
    friend class Aspose::Tasks::IO::Xml::ExtendedAttributeFactory;
    friend class Aspose::Tasks::ExtendedAttributeCollection;
    friend class Aspose::Tasks::ExtendedAttributeCollection;
    friend class Aspose::Tasks::ExtendedAttributeDefinition;
    friend class Aspose::Tasks::FormulaCalculator;
    friend class Aspose::Tasks::FormulaOperatorToken;
    friend class Aspose::Tasks::FormulaRelationalOperator;
    template<typename FT0> friend class Aspose::Tasks::Connectivity::MpdField;
    friend class Aspose::Tasks::Connectivity::MspExtendedAttribute;
    friend class Aspose::Tasks::Connectivity::MspTaskExtendedAttributeReader;
    friend class Aspose::Tasks::IO::Html::HtmlReadingUtils;
    friend class Aspose::Tasks::IO::MSProject::CustomFieldTypeReader;
    friend class Aspose::Tasks::IO::MSProject::ExtendedAttributeValueConverter;
    friend class Aspose::Tasks::IO::MSProject::MPP12AssignmentExtendedAttributeReader;
    friend class Aspose::Tasks::IO::MSProject::MPPAssignmentExtendedAttributeReader;
    friend class Aspose::Tasks::IO::MSProject::MPP12ResourceWriter;
    friend class Aspose::Tasks::IO::MSProject::MPP9ResourceWriter;
    friend class Aspose::Tasks::IO::MSProject::MPP14ResourceWriter;
    friend class Aspose::Tasks::IO::MSProject::MPP14TaskWriter;
    friend class Aspose::Tasks::IO::MSProject::MPPExtendedAttributeReader;
    friend class Aspose::Tasks::IO::MSProject::MPP12AssignmentExtendedAttributeWriter;
    friend class Aspose::Tasks::IO::MSProject::MPPAssignmentExtendedAttributeWriter;
    friend class Aspose::Tasks::IO::MSProject::MPP12ExtendedAttributeWriter;
    friend class Aspose::Tasks::IO::MSProject::MPP12TaskWriter;
    friend class Aspose::Tasks::IO::MSProject::Writers::MPP9TaskWriter;
    friend class Aspose::Tasks::IO::MSProject::MPP9AssignmentExtendedAttributeWriter;
    friend class Aspose::Tasks::IO::Mpx::MpxUtils;
    friend class Aspose::Tasks::IO::Xer::PrimaveraExtendedAttributeBuilder;
    template<typename FT0> friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ProjectCoreEntityMapperBase;
    friend class Aspose::Tasks::IO::Xml::ExtendedAttributeNodeReader;
    friend class Aspose::Tasks::IO::Xml::ExtendedAttributeNodeWriter;
    friend class Aspose::Tasks::IO::Xml::ResourceAssignmentNodeReader;
    friend class Aspose::Tasks::IO::Xml::ResourceAssignmentNodeWriter;
    friend class Aspose::Tasks::ProjectIntegrityValidator;
    friend class Aspose::Tasks::Rollup::AverageFirstSublevelRollupCalculator;
    friend class Aspose::Tasks::Rollup::AverageRollupCalculator;
    friend class Aspose::Tasks::Rollup::ChildrenCountFirstSublevelRollupCalculator;
    template<typename FT0> friend class Aspose::Tasks::Rollup::RollupCalculatorBase;
    friend class Aspose::Tasks::Rollup::ChildrenCountNonSummariesRollupCalculator;
    friend class Aspose::Tasks::Rollup::ChildrenCountRollupCalculator;
    friend class Aspose::Tasks::Rollup::DurationExtendedAttributeComparer;
    friend class Aspose::Tasks::Rollup::MinMaxRollupCalculator;
    friend class Aspose::Tasks::Rollup::SumRollupCalculator;
    friend class Aspose::Tasks::Saving::HtmlUtils;
    friend class Aspose::Tasks::Saving::MpxSavingUtils;
    friend class Aspose::Tasks::Util::ExtendedAttributeChecker;
    friend class Aspose::Tasks::Util::Fields::FieldHelperInternal;
    template<typename FT0> friend class Aspose::Tasks::Visualization::FieldToColumnText;
    
public:
 
    /// <summary>
    /// Gets the attribute definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<ExtendedAttributeDefinition> get_AttributeDefinition() const;
    /// <summary>
    /// Gets the id of a field.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_FieldId() const;
    /// <summary>
    /// Gets value for attributes with 'Duration' type.
    /// </summary>
    /// <exception cref="InvalidOperationException">Thrown if the <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not initialized or custom field type of <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not a <see cref="Duration"></see> instance.</exception>
    ASPOSE_TASKS_SHARED_API Duration get_DurationValue();
    /// <summary>
    /// Sets value for attributes with 'Duration' type.
    /// </summary>
    /// <exception cref="InvalidOperationException">Thrown if the <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not initialized or custom field type of <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not a <see cref="Duration"></see> instance.</exception>
    ASPOSE_TASKS_SHARED_API void set_DurationValue(Duration value);
    /// <summary>
    /// Gets a value for attributes with numeric types (Cost, Number).
    /// </summary>
    /// <exception cref="InvalidOperationException">Thrown if the <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not initialized or custom field type of <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not 'Cost' or 'Number'.</exception>
    ASPOSE_TASKS_SHARED_API System::Decimal get_NumericValue();
    /// <summary>
    /// Sets a value for attributes with numeric types (Cost, Number).
    /// </summary>
    /// <exception cref="InvalidOperationException">Thrown if the <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not initialized or custom field type of <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not 'Cost' or 'Number'.</exception>
    ASPOSE_TASKS_SHARED_API void set_NumericValue(System::Decimal value);
    /// <summary>
    /// Gets a value for attributes with date types (Date, Start, Finish).
    /// </summary>
    /// <exception cref="InvalidOperationException">Thrown if the <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not initialized or current attribute is not an date attribute.</exception>
    ASPOSE_TASKS_SHARED_API System::DateTime get_DateValue();
    /// <summary>
    /// Sets a value for attributes with date types (Date, Start, Finish).
    /// </summary>
    /// <exception cref="InvalidOperationException">Thrown if the <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not initialized or current attribute is not an date attribute.</exception>
    ASPOSE_TASKS_SHARED_API void set_DateValue(System::DateTime value);
    /// <summary>
    /// Gets a value indicating whether a flag is set for an attribute with 'Flag' type.
    /// </summary>
    /// <exception cref="InvalidOperationException">Thrown if the <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not initialized or current attribute is not a flag attribute.</exception>
    ASPOSE_TASKS_SHARED_API bool get_FlagValue();
    /// <summary>
    /// Sets a value indicating whether a flag is set for an attribute with 'Flag' type.
    /// </summary>
    /// <exception cref="InvalidOperationException">Thrown if the <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not initialized or current attribute is not a flag attribute.</exception>
    ASPOSE_TASKS_SHARED_API void set_FlagValue(bool value);
    /// <summary>
    /// Gets a value for attributes with 'Text' type.
    /// </summary>
    /// <exception cref="InvalidOperationException">Thrown if the <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not initialized or current attribute is not a text attribute.</exception>
    ASPOSE_TASKS_SHARED_API System::String get_TextValue();
    /// <summary>
    /// Sets a value for attributes with 'Text' type.
    /// </summary>
    /// <exception cref="InvalidOperationException">Thrown if the <see cref="ExtendedAttribute::AttributeDefinition"></see> property is not initialized or current attribute is not a text attribute.</exception>
    ASPOSE_TASKS_SHARED_API void set_TextValue(const System::String& value);
    /// <summary>
    /// Gets the guid of a lookup value.
    /// </summary>
    /// <remarks>
    /// Should not be set directly, instead use ExtendedAttributeDefinition.CreateExtendedAttribute(Value lookupValue) to create an extended attribute with a lookup value.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API System::String get_ValueGuid() const;
    /// <summary>
    /// Gets a value indicating whether a value of this <see cref="ExtendedAttribute"></see> instance is read-only.
    /// <value>returns true if a formula or rollup is defined in the <see cref="ExtendedAttributeDefinition"></see> for this object.</value>
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_ValueReadOnly() const;
    /// <summary>
    /// Gets whether calculation of extended attribute's value resulted in an error.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_IsErrorValue();
    
    /// <summary>
    /// Returns short string representation of an extended attribute.
    /// </summary>
    /// <returns>The string representation of the extended attribute.</returns>
    ASPOSE_TASKS_SHARED_API System::String ToString() const override;
    
protected:
 
    /// <summary>
    /// Gets the attribute definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_AttributeDefinition(const System::SharedPtr<ExtendedAttributeDefinition>& value);
    /// <summary>
    /// Gets the id of a field.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FieldId(const System::String& value);
    /// <summary>
    /// Gets the guid of a lookup value.
    /// </summary>
    /// <remarks>
    /// Should not be set directly, instead use ExtendedAttributeDefinition.CreateExtendedAttribute(Value lookupValue) to create an extended attribute with a lookup value.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API void set_ValueGuid(const System::String& value);
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Object> get_ErrorValue();
    /// <summary>
    /// Legacy non-strongly typed extended attribute value.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Value();
    /// <summary>
    /// Legacy non-strongly typed extended attribute value.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Value(const System::String& value);
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<IExtendedAttributeParent>& get_Parent() const;
    ASPOSE_TASKS_SHARED_API void set_Parent(const System::SharedPtr<IExtendedAttributeParent>& value);
    ASPOSE_TASKS_SHARED_API int32_t get_ValueId() const;
    ASPOSE_TASKS_SHARED_API void set_ValueId(int32_t value);
    ASPOSE_TASKS_SHARED_API bool get_IsEmpty();
    ASPOSE_TASKS_SHARED_API bool get_IsNumeric();
    
    /// <summary>
    /// Initializes a new instance of the <see cref="ExtendedAttribute"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API ExtendedAttribute();
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(ExtendedAttribute, CODEPORTING_ARGS());
    ASPOSE_TASKS_SHARED_API void CopyValueFrom(const System::SharedPtr<ExtendedAttribute>& sourceAttribute);
    ASPOSE_TASKS_SHARED_API void SetFromCalculatedValue(const System::SharedPtr<System::Object>& calculatedValue);
    static ASPOSE_TASKS_SHARED_API bool IsValueError(const System::SharedPtr<System::Object>& val);
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    static const System::String& ErrorValueDisplayText();
    static System::SharedPtr<System::Object>& errorValue();
    
    mutable System::String value;
    Duration durationValue;
    System::Decimal numericValue;
    System::DateTime dateValue;
    bool flagValue;
    System::SharedPtr<ExtendedAttributeDefinition> attributeDefinition;
    System::String pr_FieldId;
    System::String pr_ValueGuid;
    System::WeakPtr<IExtendedAttributeParent> pr_Parent;
    int32_t pr_ValueId;
    
    bool get_IsValueCalculated() const;
    bool get_HasFormula() const;
    bool get_HasRollup() const;
    
    System::String ToString_NonConst();
    System::SharedPtr<System::Object> GetCalculatedValue() const;
    System::String GetCalculatedStringValue(const System::SharedPtr<System::Object>& calculatedValue) const;
    System::Decimal GetCalculatedValueAsDecimal(const System::SharedPtr<System::Object>& calculatedValue);
    System::SharedPtr<System::Object> GetFormulaResult() const;
    void CheckDefinitionAndAttributeProperty(CustomFieldType expectedFieldType);
    void CheckDefinitionAndAttributeProperty(CustomFieldType expectedFieldType1, CustomFieldType expectedFieldType2);
    void CheckDefinitionAndAttributeProperty(CustomFieldType expectedFieldType1, CustomFieldType expectedFieldType2, CustomFieldType expectedFieldType3);
    void UpdateValues();
    void UpdateValue();
    System::Decimal ParseNumeric(const System::SharedPtr<System::Object>& val);
    System::DateTime ParseDateTime(const System::SharedPtr<System::Object>& val);
    Duration ParseDuration(const System::SharedPtr<System::Object>& val);
    static System::String ValueAsString(const System::SharedPtr<System::Object>& calculatedValue);
    
};
 
} // namespace Tasks
} // namespace Aspose