RecurringTaskParameters.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="RecurringTaskParameters.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/string.h>
#include <system/enum_helpers.h>
 
#include "aspose.tasks.cpp/Duration.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
class Calendar;
enum class Month;
enum class OrdinalNumber;
class Project;
enum class RecurrencePattern;
class RecurrencePatternBase;
class RecurrenceRangeBase;
class RecurringTaskBuilder;
class RecurringTaskInfo;
class Task;
namespace Validators
{
class RecurringTaskParametersValidator;
} // namespace Validators
enum class WeekdayType;
} // namespace Tasks
} // namespace Aspose
namespace System
{
class DateTime;
enum class DayOfWeek;
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents the set of parameters are used to create a recurring task in a project.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS RecurringTaskParameters : public System::Object
{
    typedef RecurringTaskParameters ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::RecurringTaskBuilder;
    friend class Aspose::Tasks::Validators::RecurringTaskParametersValidator;
    
private:
 
    class TaskRecurringInfoBuilder : public System::Object
    {
        typedef TaskRecurringInfoBuilder ThisType;
        typedef System::Object BaseType;
        
        typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
        RTTI_INFO_DECL();
        
    public:
    
        System::SharedPtr<RecurringTaskInfo> Build(const System::SharedPtr<Task>& task, const System::SharedPtr<RecurringTaskParameters>& parameters);
        
    private:
    
        int32_t GetDailyRepetitions(const System::SharedPtr<RecurrencePatternBase>& pattern);
        System::DateTime GetFinishDate(const System::SharedPtr<RecurrenceRangeBase>& rangeBase);
        int32_t GetMonthlyDay(const System::SharedPtr<RecurrencePatternBase>& pattern);
        System::DayOfWeek GetMonthlyOrdinalDay(const System::SharedPtr<RecurrencePatternBase>& pattern);
        OrdinalNumber GetMonthlyOrdinalNumber(const System::SharedPtr<RecurrencePatternBase>& pattern);
        int32_t GetMonthlyOrdinalRepetitions(const System::SharedPtr<RecurrencePatternBase>& pattern);
        int32_t GetMonthlyRepetitions(const System::SharedPtr<RecurrencePatternBase>& pattern);
        int32_t GetOccurrences(const System::SharedPtr<RecurrencePatternBase>& patternBase);
        RecurrencePattern GetRecurrencePatternType(const System::SharedPtr<RecurrencePatternBase>& pattern);
        WeekdayType GetWeeklyDays(const System::SharedPtr<RecurrencePatternBase>& pattern);
        int32_t GetWeeklyRepetitions(const System::SharedPtr<RecurrencePatternBase>& pattern);
        System::DateTime GetYearlyDate(const System::SharedPtr<RecurrencePatternBase>& pattern, const System::SharedPtr<Task>& task);
        System::DayOfWeek GetYearlyOrdinalDay(const System::SharedPtr<RecurrencePatternBase>& pattern);
        Month GetYearlyOrdinalMonth(const System::SharedPtr<RecurrencePatternBase>& pattern);
        OrdinalNumber GetYearlyOrdinalNumber(const System::SharedPtr<RecurrencePatternBase>& pattern);
        bool IsDailyUseWorkDays(const System::SharedPtr<RecurrencePatternBase>& pattern);
        bool IsMonthlyUseOrdinalDay(const System::SharedPtr<RecurrencePatternBase>& pattern);
        bool IsUseEndDate(const System::SharedPtr<RecurrenceRangeBase>& recurrenceRange);
        bool IsYearlyUseOrdinalDay(const System::SharedPtr<RecurrencePatternBase>& pattern);
        
    };
    
    
public:
 
    /// <summary>
    /// Gets the duration for one occurrence of the recurring task.
    /// <remarks>The instance of <see cref="Duration"></see> class.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::Duration get_Duration() const;
    /// <summary>
    /// Sets the duration for one occurrence of the recurring task.
    /// <remarks>The instance of <see cref="Duration"></see> class.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Duration(Aspose::Tasks::Duration value);
    /// <summary>
    /// Gets a value indicating whether to schedule the recurring task even if it does not happen when any resources are available to work on it.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_IgnoreResourceCalendar() const;
    /// <summary>
    /// Sets a value indicating whether to schedule the recurring task even if it does not happen when any resources are available to work on it.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_IgnoreResourceCalendar(bool value);
    /// <summary>
    /// Gets the recurrence pattern of the recurring task.
    /// <remarks>Can be one of the values of <see cref="RecurrencePattern"></see> enumeration.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<RecurrencePatternBase>& get_RecurrencePattern() const;
    /// <summary>
    /// Sets the recurrence pattern of the recurring task.
    /// <remarks>Can be one of the values of <see cref="RecurrencePattern"></see> enumeration.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_RecurrencePattern(const System::SharedPtr<RecurrencePatternBase>& value);
    /// <summary>
    /// Gets the name of the recurring task.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_TaskName() const;
    /// <summary>
    /// Sets the name of the recurring task.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_TaskName(const System::String& value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="RecurringTaskParameters"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API RecurringTaskParameters();
    
    /// <summary>
    /// Set a calendar for recurring task. The calendar is selected from project calendar collection.
    /// </summary>
    /// <param name="project">The project with calendar collection.</param>
    /// <param name="calendarName">The name of calendar.</param>
    ASPOSE_TASKS_SHARED_API void SetCalendar(const System::SharedPtr<Project>& project, const System::String& calendarName);
    
protected:
 
    /// <summary>
    /// Gets the calendar which is used to schedule tasks.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<Aspose::Tasks::Calendar>& get_Calendar() const;
    
    ASPOSE_TASKS_SHARED_API void EnsureInitializationIsDone();
    ASPOSE_TASKS_SHARED_API System::SharedPtr<RecurringTaskInfo> GetRecurringInfo(const System::SharedPtr<Task>& task);
    
    virtual ASPOSE_TASKS_SHARED_API ~RecurringTaskParameters();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    Aspose::Tasks::Duration pr_Duration;
    bool pr_IgnoreResourceCalendar;
    System::SharedPtr<RecurrencePatternBase> pr_RecurrencePattern;
    System::String pr_TaskName;
    System::SharedPtr<Aspose::Tasks::Calendar> pr_Calendar;
    
    /// <summary>
    /// Gets the calendar which is used to schedule tasks.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Calendar(const System::SharedPtr<Aspose::Tasks::Calendar>& value);
    
};
 
} // namespace Tasks
} // namespace Aspose