com.aspose.tasks

Interfaces

Classes

Exceptions

com.aspose.tasks

Class Calendar



  • public class Calendar
    extends Object

    Represents a calendar used in a project. How to create simple calendar from scratch. // create empty calendar Calendar calendar = new Calendar(); // adds default working days (8 working hours from 9:00 to 17:00) calendar.getDays().add(WeekDay.createDefaultWorkingDay(DayType.Monday)); calendar.getDays().add(WeekDay.createDefaultWorkingDay(DayType.Tuesday)); calendar.getDays().add(WeekDay.createDefaultWorkingDay(DayType.Wednesday)); // create new new working day WeekDay myWeekDay = new WeekDay(DayType.Thursday); // Sets working time. Only time part of DateTime is important WorkingTime wt1 = new WorkingTime(); wt1.setFromTime(new Date(1, 1, 1, 6, 0, 0)); wt1.setToTime(new Date(1, 1, 1, 12, 0, 0)); WorkingTime wt2 = new WorkingTime(); wt2.setFromTime(new Date(1, 1, 1, 14, 0, 0)); wt2.setToTime(new Date(1, 1, 1, 18, 0, 0)); myWeekDay.getWorkingTimes().add(wt1); myWeekDay.getWorkingTimes().add(wt2); myWeekDay.setDayWorking(true); calendar.getDays().add(myWeekDay); calendar.getDays().add(WeekDay.createDefaultWorkingDay(DayType.Friday)); // adds weekend calendar.getDays().add(new WeekDay(DayType.Saturday)); calendar.getDays().add(new WeekDay(DayType.Sunday)); Calendars are used to define standard working and non-working times. Projects must have one base calendar. Tasks and resources can have their own non-base calendars that are based on a base calendar.

    • Constructor Detail

      • Calendar

        @Deprecated
        public Calendar(String name)
        Deprecated. The constructor is not used anymore and will be removed after the release 20.10. Use Project.getCalendars().add() method's overloads instead.

        Initializes a new instance of the Calendar class with the specified name.

        Parameters:
        name - The name of the created calendar.
    • Method Detail

      • delete

        public final void delete()

        Removes calendar from project.

      • equals

        public boolean equals(Object obj)

        Returns a value indicating whether this instance is equal to a specified object.

        Overrides:
        equals in class Object
        Parameters:
        obj - The object to compare with this instance.
        Returns:
        <b>True</b> if o is a Calendar that has the same Uid value as this instance; otherwise, <b>false</b>.
      • getBaseCalendar

        public final Calendar getBaseCalendar()

        Gets the base calendar on which this calendar depends. Only applicable if the calendar is not a base calendar. Read/write Calendar.

        Returns:
        the base calendar on which this calendar depends.
      • setBaseCalendar

        public final void setBaseCalendar(Calendar value)

        Sets the base calendar on which this calendar depends. Only applicable if the calendar is not a base calendar. Read/write Calendar.

        Parameters:
        value - the base calendar on which this calendar depends.
      • getExceptions

        public final CalendarExceptionCollection getExceptions()

        Gets CalendarExceptionCollection object. The collection of exceptions that is associated with the calendar.

        Returns:
        CalendarExceptionCollection object.
      • getFinishDateByStartAndWork

        public final Date getFinishDateByStartAndWork(Date start,
                                                      Duration work)

        Calculates the date when the specified amount of work time will pass according to the calendar.

        Parameters:
        start - Start date.
        work - Work duration.
        Returns:
        Finish date.
      • getFinishDateByStartAndWork

        public final Date getFinishDateByStartAndWork(Date start,
                                                      double work)

        Calculates the date when the specified amount of work time will pass according to the calendar.

        Parameters:
        start - Start date.
        work - Work duration.
        Returns:
        Finish date.
      • getName

        public final String getName()

        Gets the name of the calendar. Read/write String.

        Returns:
        the name of the calendar.
      • setName

        public final void setName(String value)

        Sets the name of the calendar. Read/write String.

        Parameters:
        value - the name of the calendar.
      • getNextWorkingDayStart

        public final Date getNextWorkingDayStart(Date date)

        Calculates next working day start from the date.

        Parameters:
        date - The date to get next working day start for.
        Returns:
        Next working day start Date.
      • getParentProject

        public final Project getParentProject()

        Gets parent project for this calendar.

        Returns:
        parent project for this calendar.
      • getPreviousWorkingDayEnd

        public final Date getPreviousWorkingDayEnd(Date date)

        Calculates previous working date end from the specified date.

        Parameters:
        date - the specified instance of Date struct.
        Returns:
        Previous working day start Date
      • getStartDateFromFinishAndDuration

        public final Date getStartDateFromFinishAndDuration(Date finish,
                                                            Duration duration)

        Returns StartDate based on specified FinishDate and Duration.

        Parameters:
        finish - The specified finish date.
        duration - The specified work duration.
        Returns:
        Calculated StartDate.
      • getStartDateFromFinishAndDuration

        public final Date getStartDateFromFinishAndDuration(Date finish,
                                                            double duration)

        Returns StartDate based on specified FinishDate and Duration.

        Parameters:
        finish - The specified finish date.
        duration - The specified work duration.
        Returns:
        Calculated StartDate.
      • getTaskFinishDateFromDuration

        public final Date getTaskFinishDateFromDuration(Task task,
                                                        double duration)

        Calculates the task finish date and time from its start date, split parts and the duration.

        Parameters:
        task - The task to get finish date for.
        duration - The task duration to split on.


        Returns DateTime.MinValue if task is summary, null or its start date is not set.
        Returns:
        Task's finish date.
      • getUid

        public final int getUid()

        Gets the unique identifier of the calendar. Read/write int.

        Returns:
        the unique identifier of the calendar.
      • setUid

        public final void setUid(int value)

        Sets the unique identifier of the calendar. Read/write int.

        Parameters:
        value - the unique identifier of the calendar.
      • getWeekDays

        public final WeekDayCollection getWeekDays()

        Gets WeekDaysCollection for this calendar. The collection of weekdays that defines the calendar.

        Returns:
        WeekDaysCollection for this calendar.
      • getWorkWeeks

        public final WorkWeekCollection getWorkWeeks()

        Gets WorkWeekCollections object. The collection of work weeks that is associated with the calendar.

        Returns:
        WorkWeekCollections object.
      • getWorkingHours

        public final WorkUnit getWorkingHours(Date start,
                                              Date finish)

        Return working hours for the specified dates.

        Parameters:
        start - Start date.
        finish - Finish date.
        Returns:
        Working hours.
      • getWorkingHours

        public final double getWorkingHours(Date dt)

        Returns amount of working hours at the date.

        Parameters:
        dt - The date to get working hours for.
        Returns:
        Working hours.
      • hashCode

        public int hashCode()

        Returns a hash code for the instance of the Calendar class.

        Overrides:
        hashCode in class Object
        Returns:
        a hash code for this object.
      • isBaseCalendar

        public final boolean isBaseCalendar()

        Gets a value indicating whether the calendar is a base calendar. Read-only boolean.

        Returns:
        a value indicating whether the calendar is a base calendar.
      • isBaselineCalendar

        public final boolean isBaselineCalendar()

        Gets a value indicating whether the calendar is a baseline calendar. Read/write boolean.


        This is a new for MS Project 2010 property. Reading supported for XML format only. Returns false if not defined.
        Returns:
        a value indicating whether the calendar is a baseline calendar.
      • setBaselineCalendar

        public final void setBaselineCalendar(boolean value)

        Sets a value indicating whether the calendar is a baseline calendar. Read/write boolean.


        This is a new for MS Project 2010 property. Reading supported for XML format only. Returns false if not defined.
        Parameters:
        value - a value indicating whether the calendar is a baseline calendar.
      • isDayWorking

        public final boolean isDayWorking(Date dt)

        Determines whether the day is working day.

        Parameters:
        dt - The date to check day is working for.
        Returns:
        True if the day is working day.
      • make24HourCalendar

        @Deprecated
        public static Calendar make24HourCalendar()
        Deprecated. The method is not used anymore and will be removed after the release 20.10. Use the Calendar.Make24HourCalendar(Calendar) method instead.

        Creates 24Hours Calendar named "24 Hours". 24Hours Calendar is a Calendar in which every day of week is working with Round-the-clock working hours.

        Returns:
        Created 24Hour Calendar.
      • make24HourCalendar

        public static Calendar make24HourCalendar(Calendar calendar)

        Makes a given Calendar to be a 24Hour Calendar. 24Hours Calendar is a Calendar in which every day of week is working with Round-the-clock working hours.

        Parameters:
        calendar - Calendar to make 24 Hours Calendar from.
        Returns:
        24Hour Calendar.
      • makeNightShiftCalendar

        @Deprecated
        public static Calendar makeNightShiftCalendar()
        Deprecated. The method is not used anymore and will be removed after the release 20.10. Use the Calendar.MakeNightShiftCalendar(Calendar) method instead.

        Creates Night Shift Calendar named "Night shift".

        Returns:
        Created Night Shift Calendar.
      • makeNightShiftCalendar

        public static Calendar makeNightShiftCalendar(Calendar calendar)

        Makes a given Calendar as Night Shift Calendar.

        Parameters:
        calendar - Calendar to make Night Shift Calendar.
        Returns:
        Night Shift Calendar.
      • makeStandardCalendar

        @Deprecated
        public static Calendar makeStandardCalendar()
        Deprecated. The method is not used anymore and will be removed after the release 20.10. Use the Calendar.MakeStandardCalendar(Calendar) method instead.

        Creates default standard calendar.

        Returns:
        Created calendar.
      • makeStandardCalendar

        public static Calendar makeStandardCalendar(Calendar calendar)

        Creates default standard calendar.

        Parameters:
        calendar - Calendar to make standard calendar from.
        Returns:
        Created calendar.