com.aspose.tasks

Interfaces

Classes

Exceptions

com.aspose.tasks

Class CalendarException



  • public class CalendarException
    extends Object

    Represent exceptional time periods in a calendar.

    • Constructor Summary

      Constructors 
      Constructor and Description
      CalendarException()
      Initializes a new instance of the CalendarException class.
    • Constructor Detail

      • CalendarException

        public CalendarException()

        Initializes a new instance of the CalendarException class.

    • Method Detail

      • getDayWorking

        public boolean getDayWorking()

        Determines whether the specified date or day type is working. Read/write boolean.

        Returns:
        true if the specified date or day type is working.
      • setDayWorking

        public void setDayWorking(boolean value)

        Determines whether the specified date or day type is working. Read/write boolean.

        Parameters:
        value - true if the specified date or day type is working.
      • getDaysOfWeek

        public DayTypeCollection getDaysOfWeek()

        Returns DayTypeCollection for this object. The days of the week on which the exception is valid. Read only DayTypeCollection instance.

        Returns:
        the collection of the days of the week on which the exception is valid.
      • getEnteredByOccurrences

        public boolean getEnteredByOccurrences()

        Determines whether the range of recurrence is defined by entering a number of occurrences. False specifies that the range of recurrence is defined by entering a finish date. Read/write boolean.

        Returns:
        true if the range of recurrence is defined by entering a number of occurrences.
      • setEnteredByOccurrences

        public void setEnteredByOccurrences(boolean value)

        Determines whether the range of recurrence is defined by entering a number of occurrences. False specifies that the range of recurrence is defined by entering a finish date. Read/write boolean.

        Parameters:
        value - true if the range of recurrence is defined by entering a number of occurrences.
      • getFromDate

        public Date getFromDate()

        Returns the beginning of the exception time. Read/write Date.

        Returns:
        from date.
      • setFromDate

        public void setFromDate(Date value)

        Sets the beginning of the exception time. Read/write Date.

        Parameters:
        value - from date.
      • getMonth

        public int getMonth()

        Returns the month for which an exception recurrence is scheduled. Read/write Month.

        Returns:
        exception month.
      • setMonth

        public void setMonth(int value)

        Sets the month for which an exception recurrence is scheduled. Read/write Month.

        Parameters:
        value - exception month.
      • getMonthDay

        public int getMonthDay()

        Returns the day of a month on which an exception recurrence is scheduled. Read/write int.

        Returns:
        exception month day.
      • setMonthDay

        public void setMonthDay(int value)

        Sets the day of a month on which an exception recurrence is scheduled. Read/write int.

        Parameters:
        value - exception month day.
      • getMonthItem

        public int getMonthItem()

        Returns the month item for which an exception recurrence is scheduled. Read/write MonthItemType.

        Returns:
        exception month item.
      • setMonthItem

        public void setMonthItem(int value)
        Sets the month item for which an exception recurrence is scheduled.
        Parameters:
        value - exception month item.
      • getMonthPosition

        public int getMonthPosition()

        Returns the position of a month item within a month. Read/write MonthPosition.

        Returns:
        exception month position.
      • setMonthPosition

        public void setMonthPosition(int value)

        Sets the position of a month item within a month. Read/write MonthPosition.

        Parameters:
        value - exception month position.
      • getName

        public String getName()

        Returns the name of the exception. Read/write String.

        Returns:
        exception name.
      • setName

        public void setName(String value)

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

        Parameters:
        value - exception name.
      • getOccurrences

        public int getOccurrences()

        Returns the number of occurrences for which the calendar exception is valid. Read/write int.

        Returns:
        the number of occurrences for which the calendar exception is valid.
      • setOccurrences

        public void setOccurrences(int value)

        Sets the number of occurrences for which the calendar exception is valid. Read/write int.

        Parameters:
        value - the number of occurrences for which the calendar exception is valid.
      • getParentCalendar

        public Calendar getParentCalendar()

        Returns parent calendar for this object. Read only Calendar.

        Returns:
        parent calendar for this object.
      • getPeriod

        public int getPeriod()

        Returns the period of recurrence for the exception. Read/write int.

        Returns:
        exception period.
      • setPeriod

        public void setPeriod(int value)

        Sets the period of recurrence for the exception. Read/write int.

        Parameters:
        value - exception period.
      • getToDate

        public Date getToDate()

        Returns the end of the exception time. Read/write Date.

        Returns:
        exception time end.
      • setToDate

        public void setToDate(Date value)

        Sets the end of the exception time. Read/write Date.

        Parameters:
        value - exception time end.
      • getType

        public int getType()

        Returns the exception type. Read/write CalendarExceptionType.

        Returns:
        exception type.
      • setType

        public void setType(int value)

        Sets the exception type. Read/write CalendarExceptionType.

        Parameters:
        value - exception type.
      • getWorkingTime

        public double getWorkingTime()

        Returns the working time for a calendar exception.

        Returns:
        Working time.
      • getWorkingTimes

        public WorkingTimeCollection getWorkingTimes()

        Returns the collection of working times that defines the time worked on the weekday. Read only WorkingTimeCollection instance. At least one working time must present, and there can't be more than five.

        Returns:
        the collection of working times that defines the time worked on the weekday.
      • setWorkingTimes

        public void setWorkingTimes(WorkingTimeCollection value)
        Sets the collection of working times that defines the time worked on the weekday.
        Parameters:
        value - the collection of working times that defines the time worked on the weekday.
      • checkException

        public boolean checkException(Date dt)

        Returns true if dt is the exception day

        Parameters:
        dt - date to check exception for.
        Returns:
        true if dt is the exception day
      • delete

        public void delete()

        Deletes the Exception instance from parent calendar CalendarExceptionCollection object.