Package com.appiancorp.suiteapi.process

Class RecurringInterval.Yearly

java.lang.Object
com.appiancorp.suiteapi.process.RecurringInterval.Yearly
All Implemented Interfaces:
Serializable
Enclosing class:
RecurringInterval
public static class RecurringInterval.Yearly extends Object implements Serializable
Class defines time interval for Yearly events. Yearly events can occur on a specific day of the month i.e. on "10th day of Jan" or on a specific week day of the month i.e. on "SECOND Friday of March".
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Yearly()
     
    Yearly(boolean weekdayBased_)
    Create a new yearly object

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    getDayOfMonth()
    Returns the day of the month on which the event occurs
    String
    getDayOfMonthExpr()
    Gets the day of the month on which the event occurs
    Integer
    getDayOfWeek()
    Returns the day of the day of the week on which event occurs.
    Integer
    getMonth()
    Gets the month of the year on which Yearly event occurs.
    boolean
    getWeekdayBased()
    Returns true if the Yearly events occur on a particular day of a week of month like "Third Wednesday of Jan", else false.
    Integer
    getWeekType()
    Gets the Week of the month on which the Yearly event occurs.
    void
    setDayOfMonth(Integer dayOfMonth_)
    Sets the day of the month on which event occurs
    void
    setDayOfMonthExpr(String dayOfMonthExpr_)
    Sets the day of the month on which the event occurs
    void
    setDayOfWeek(Integer dayOfWeek_)
    Sets the day of the week on which the day of the week on which event occurs.
    void
    setMonth(Integer month_)
    Set the month of the year on which Yearly event occurs.
    void
    setWeekdayBased(boolean weekdayBased_)
    Set tp true if the Yearly events occur on a particular day of a week of month like "Third Wednesday of Jan", else false.
    void
    setWeekType(Integer dayType_)
    Sets the Week of the month on which the Yearly event occurs.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Yearly

      public Yearly()

    • Yearly

      public Yearly(boolean weekdayBased_)
      Create a new yearly object
      Parameters:
      weekdayBased_ - true if the Yearly events occur on a specific day of a week of month like R"SECOND Friday of March".

  • Method Details

    • getDayOfMonth

      public Integer getDayOfMonth()
      Returns the day of the month on which the event occurs
      Returns:
      1 - 31

    • setDayOfMonth

      public void setDayOfMonth(Integer dayOfMonth_)
      Sets the day of the month on which event occurs
      Parameters:
      dayOfMonth_ - 1 - 31
      Throws:
      IllegalArgumentException - if the parameters is not between 1 - 31

    • getDayOfWeek

      public Integer getDayOfWeek()
      Returns the day of the day of the week on which event occurs. SUNDAY = 1, MONDAY = 2, TUESDAY = 3, WEDNESDAY = 4, THURSDAY = 5, FRIDAY = 6, SATURDAY = 7
      Returns:
      1 - 7

    • setDayOfWeek

      public void setDayOfWeek(Integer dayOfWeek_)
      Sets the day of the week on which the day of the week on which event occurs. SUNDAY = 1, MONDAY = 2, TUESDAY = 3, WEDNESDAY = 4, THURSDAY = 5, FRIDAY = 6, SATURDAY = 7
      Parameters:
      dayOfWeek_ - between 1 - 7

    • getWeekType

      public Integer getWeekType()
      Gets the Week of the month on which the Yearly event occurs. This property is used to specify monthly event like "Third Wednesday of Jan".
      See Also:

    • setWeekType

      public void setWeekType(Integer dayType_)
      Sets the Week of the month on which the Yearly event occurs. This property is used to specify monthly event like "Third Wednesday of Jan".
      See Also:

    • getWeekdayBased

      public boolean getWeekdayBased()
      Returns true if the Yearly events occur on a particular day of a week of month like "Third Wednesday of Jan", else false.

    • setWeekdayBased

      public void setWeekdayBased(boolean weekdayBased_)
      Set tp true if the Yearly events occur on a particular day of a week of month like "Third Wednesday of Jan", else false.

    • getMonth

      public Integer getMonth()
      Gets the month of the year on which Yearly event occurs. Jan = 0, Feb = 1 ..... Dec = 11

    • setMonth

      public void setMonth(Integer month_)
      Set the month of the year on which Yearly event occurs.
      Parameters:
      month_ - integer representing month of the year: Jan = 0, Feb = 1 -- Dec = 11

    • getDayOfMonthExpr

      public String getDayOfMonthExpr()
      Gets the day of the month on which the event occurs
      Returns:
      an expression resolving to a number (integer) between 1 and 31

    • setDayOfMonthExpr

      public void setDayOfMonthExpr(String dayOfMonthExpr_)
      Sets the day of the month on which the event occurs
      Parameters:
      dayOfMonth_ - an expression resolving to a number (integer) between 1 and 31