FilterCriteria.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="FilterCriteria.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/array.h>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
enum class Field;
enum class FilterComparisonType;
enum class FilterOperation;
namespace IO
{
namespace MSProject
{
class MPPFilterCriteriaReader;
class MPPFilterCriteriaWriter;
} // namespace MSProject
} // namespace IO
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class List;
} // namespace Generic
} // namespace Collections
namespace Text
{
class StringBuilder;
} // namespace Text
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
///  Defines the criteria that tasks or resources must meet to be displayed in MSP view.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS FilterCriteria : public System::Object
{
    typedef FilterCriteria ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::IO::MSProject::MPPFilterCriteriaWriter;
    friend class Aspose::Tasks::IO::MSProject::MPPFilterCriteriaReader;
    
public:
 
    /// <summary>
    /// Gets the criterion established with FieldName, Test, and Value relates to other criteria in the filter.
    /// </summary>
    ASPOSE_TASKS_SHARED_API FilterOperation get_Operation() const;
    /// <summary>
    /// Sets the criterion established with FieldName, Test, and Value relates to other criteria in the filter.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Operation(FilterOperation value);
    /// <summary>
    /// Gets a <see cref="Field"></see> to change.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::Field get_Field() const;
    /// <summary>
    /// Sets a <see cref="Field"></see> to change.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Field(Aspose::Tasks::Field value);
    /// <summary>
    /// Gets the type of comparison made between FieldName and Value that acts as selection criteria for the filter.
    /// <see cref="FilterComparisonType"></see>
    /// </summary>
    ASPOSE_TASKS_SHARED_API FilterComparisonType get_Test() const;
    /// <summary>
    /// Sets the type of comparison made between FieldName and Value that acts as selection criteria for the filter.
    /// <see cref="FilterComparisonType"></see>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Test(FilterComparisonType value);
    /// <summary>
    /// Gets the object values to compare with the value of the field specified with FieldName.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::ArrayPtr<System::SharedPtr<System::Object>> get_Values() const;
    /// <summary>
    /// Gets the list of child <see cref="FilterCriteria"></see> rows.
    /// If the filter contains more than one criterion row then the effect of an And operator is that the criteria for both rows must be met for the task or resource to be displayed as a result of this filter.
    /// The effect of an Or operator is that the criteria for one or the other row must be met.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<FilterCriteria>>> get_CriteriaRows() const;
    
    /// <summary>
    /// Gets whether the right-hand value of FilterCriteria is a field reference, not a constant value.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool IsFieldValue();
    /// <summary>
    /// Sets the field whose value will be compared with the value of the field specified by FieldName.
    /// </summary>
    /// <param name="value">Field which will serve as right-hand value of filter criteria.</param>
    ASPOSE_TASKS_SHARED_API void SetValueField(Aspose::Tasks::Field value);
    /// <summary>
    /// Returns string representation of the instance of the <see cref="FilterCriteria"></see> class.
    /// </summary>
    /// <returns>string representation of this object.</returns>
    ASPOSE_TASKS_SHARED_API System::String ToString() const override;
    
    ASPOSE_TASKS_SHARED_API FilterCriteria();
    
protected:
 
    /// <summary>
    /// Gets the object values to compare with the value of the field specified with FieldName.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Values(const System::ArrayPtr<System::SharedPtr<System::Object>>& value);
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::ArrayPtr<System::SharedPtr<System::Object>> values;
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<FilterCriteria>>> criteriaRows;
    FilterOperation pr_Operation;
    Aspose::Tasks::Field pr_Field;
    FilterComparisonType pr_Test;
    
    void AppendValues(const System::SharedPtr<System::Text::StringBuilder>& sb) const;
    
};
 
} // namespace Tasks
} // namespace Aspose