RecurringTaskInfo.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="RecurringTaskInfo.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/object.h>
#include <system/enum_helpers.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 IO
{
namespace Mpx
{
class MpxReader;
} // namespace Mpx
namespace MSProject
{
class MPPRecurringInfoReader;
} // namespace MSProject
} // namespace IO
enum class Month;
enum class OrdinalNumber;
enum class RecurrencePattern;
class RecurringTaskParameters;
class Task;
enum class WeekdayType;
} // namespace Tasks
} // namespace Aspose
namespace System
{
enum class DayOfWeek;
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents the details of a recurring task in a project.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS RecurringTaskInfo : public System::Object
{
    typedef RecurringTaskInfo ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::IO::MSProject::MPPRecurringInfoReader;
    friend class Aspose::Tasks::IO::Mpx::MpxReader;
    friend class Aspose::Tasks::RecurringTaskParameters;
    
public:
 
    /// <summary>
    /// Gets a 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 Aspose::Tasks::RecurrencePattern get_RecurrencePattern() const;
    /// <summary>
    /// Sets a 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(Aspose::Tasks::RecurrencePattern value);
    /// <summary>
    /// Gets the date for the occurrences to begin.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DateTime get_StartDate() const;
    /// <summary>
    /// Sets the date for the occurrences to begin.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_StartDate(System::DateTime value);
    /// <summary>
    /// Gets the date for the occurrences to end.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DateTime get_EndDate() const;
    /// <summary>
    /// Sets the date for the occurrences to end.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_EndDate(System::DateTime value);
    /// <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 number of occurrences of the recurring task.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Occurrences() const;
    /// <summary>
    /// Sets a number of occurrences of the recurring task.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Occurrences(int32_t value);
    /// <summary>
    /// Gets a value indicating whether to use the end date or a number of occurrences for the recurring task.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_UseEndDate() const;
    /// <summary>
    /// Sets a value indicating whether to use the end date or a number of occurrences for the recurring task.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_UseEndDate(bool value);
    /// <summary>
    /// Gets a number of repetitions for the daily recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_DailyRepetitions() const;
    /// <summary>
    /// Sets a number of repetitions for the daily recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_DailyRepetitions(int32_t value);
    /// <summary>
    /// Gets a value indicating whether to use workdays for the daily recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_DailyUseWorkdays() const;
    /// <summary>
    /// Sets a value indicating whether to use workdays for the daily recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_DailyUseWorkdays(bool value);
    /// <summary>
    /// Gets a number of repetitions for the weekly recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_WeeklyRepetitions() const;
    /// <summary>
    /// Sets a number of repetitions for the weekly recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_WeeklyRepetitions(int32_t value);
    /// <summary>
    /// Gets a collection of days used in the weekly recurrence pattern.
    /// <remarks></remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API WeekdayType get_WeeklyDays() const;
    /// <summary>
    /// Sets a collection of days used in the weekly recurrence pattern.
    /// <remarks></remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_WeeklyDays(WeekdayType value);
    /// <summary>
    /// Gets a value indicating whether to use ordinal day for the monthly recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_MonthlyUseOrdinalDay() const;
    /// <summary>
    /// Sets a value indicating whether to use ordinal day for the monthly recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_MonthlyUseOrdinalDay(bool value);
    /// <summary>
    /// Gets an ordinal number of the monthly recurrence pattern.
    /// <remarks>Can be one of the values of <see cref="OrdinalNumber"></see> enumeration.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API OrdinalNumber get_MonthlyOrdinalNumber() const;
    /// <summary>
    /// Sets an ordinal number of the monthly recurrence pattern.
    /// <remarks>Can be one of the values of <see cref="OrdinalNumber"></see> enumeration.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_MonthlyOrdinalNumber(OrdinalNumber value);
    /// <summary>
    /// Gets a day of the monthly recurrence pattern when using ordinal day.
    /// <remarks>Can be one of the values of <see cref="DayOfWeek"></see> enumeration.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DayOfWeek get_MonthlyOrdinalDay() const;
    /// <summary>
    /// Sets a day of the monthly recurrence pattern when using ordinal day.
    /// <remarks>Can be one of the values of <see cref="DayOfWeek"></see> enumeration.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_MonthlyOrdinalDay(System::DayOfWeek value);
    /// <summary>
    /// Gets a number of repetitions for the monthly recurrence pattern when using ordinal day.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_MonthlyOrdinalRepetitions() const;
    /// <summary>
    /// Sets a number of repetitions for the monthly recurrence pattern when using ordinal day.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_MonthlyOrdinalRepetitions(int32_t value);
    /// <summary>
    /// Gets a number of day of the monthly recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_MonthlyDay() const;
    /// <summary>
    /// Sets a number of day of the monthly recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_MonthlyDay(int32_t value);
    /// <summary>
    /// Gets a number of repetitions for the monthly recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_MonthlyRepetitions() const;
    /// <summary>
    /// Sets a number of repetitions for the monthly recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_MonthlyRepetitions(int32_t value);
    /// <summary>
    /// Gets a value indicating whether to use ordinal day for the yearly recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_YearlyUseOrdinalDay() const;
    /// <summary>
    /// Sets a value indicating whether to use ordinal day for the yearly recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_YearlyUseOrdinalDay(bool value);
    /// <summary>
    /// Gets a date for the yearly recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DateTime get_YearlyDate() const;
    /// <summary>
    /// Sets a date for the yearly recurrence pattern.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_YearlyDate(System::DateTime value);
    /// <summary>
    /// Gets an ordinal number of the yearly recurrence pattern.
    /// <remarks>Can be one of the values of <see cref="OrdinalNumber"></see> enumeration.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API OrdinalNumber get_YearlyOrdinalNumber() const;
    /// <summary>
    /// Sets an ordinal number of the yearly recurrence pattern.
    /// <remarks>Can be one of the values of <see cref="OrdinalNumber"></see> enumeration.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_YearlyOrdinalNumber(OrdinalNumber value);
    /// <summary>
    /// Gets a weekday of the yearly recurrence pattern when using ordinal day.
    /// <remarks>Can be one of the values of <see cref="DayOfWeek"></see> enumeration.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::DayOfWeek get_YearlyOrdinalDay() const;
    /// <summary>
    /// Sets a weekday of the yearly recurrence pattern when using ordinal day.
    /// <remarks>Can be one of the values of <see cref="DayOfWeek"></see> enumeration.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_YearlyOrdinalDay(System::DayOfWeek value);
    /// <summary>
    /// Gets a month of the yearly recurrence pattern when using ordinal day.
    /// <remarks>Can be one of the values of <see cref="Month"></see> enumeration.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API Month get_YearlyOrdinalMonth() const;
    /// <summary>
    /// Sets a month of the yearly recurrence pattern when using ordinal day.
    /// <remarks>Can be one of the values of <see cref="Month"></see> enumeration.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_YearlyOrdinalMonth(Month value);
    /// <summary>
    /// Gets the parent task of this instance of <see cref="RecurringTaskInfo"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<Aspose::Tasks::Task>& get_Task() const;
    
protected:
 
    /// <summary>
    /// Gets the parent task of this instance of <see cref="RecurringTaskInfo"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Task(const System::SharedPtr<Aspose::Tasks::Task>& value);
    
    ASPOSE_TASKS_SHARED_API RecurringTaskInfo();
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(RecurringTaskInfo, CODEPORTING_ARGS());
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    Aspose::Tasks::RecurrencePattern pr_RecurrencePattern;
    System::DateTime pr_StartDate;
    System::DateTime pr_EndDate;
    Aspose::Tasks::Duration pr_Duration;
    int32_t pr_Occurrences;
    bool pr_UseEndDate;
    int32_t pr_DailyRepetitions;
    bool pr_DailyUseWorkdays;
    int32_t pr_WeeklyRepetitions;
    WeekdayType pr_WeeklyDays;
    bool pr_MonthlyUseOrdinalDay;
    OrdinalNumber pr_MonthlyOrdinalNumber;
    System::DayOfWeek pr_MonthlyOrdinalDay;
    int32_t pr_MonthlyOrdinalRepetitions;
    int32_t pr_MonthlyDay;
    int32_t pr_MonthlyRepetitions;
    bool pr_YearlyUseOrdinalDay;
    System::DateTime pr_YearlyDate;
    OrdinalNumber pr_YearlyOrdinalNumber;
    System::DayOfWeek pr_YearlyOrdinalDay;
    Month pr_YearlyOrdinalMonth;
    System::WeakPtr<Aspose::Tasks::Task> pr_Task;
    
};
 
} // namespace Tasks
} // namespace Aspose