Package com.appiancorp.suiteapi.process
Class RecurringInterval.Yearly
java.lang.Object
com.appiancorp.suiteapi.process.RecurringInterval.Yearly
- All Implemented Interfaces:
Serializable
- Enclosing class:
- RecurringInterval
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
-
Method Summary
Modifier and TypeMethodDescriptionReturns the day of the month on which the event occursGets the day of the month on which the event occursReturns the day of the day of the week on which event occurs.getMonth()
Gets the month of the year on which Yearly event occurs.boolean
Returns true if the Yearly events occur on a particular day of a week of month like "Third Wednesday of Jan", else false.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 occursvoid
setDayOfMonthExpr
(String dayOfMonthExpr_) Sets the day of the month on which the event occursvoid
setDayOfWeek
(Integer dayOfWeek_) Sets the day of the week on which the day of the week on which event occurs.void
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.
-
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
Returns the day of the month on which the event occurs- Returns:
- 1 - 31
-
setDayOfMonth
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
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
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
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". -
setWeekType
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". -
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
Gets the month of the year on which Yearly event occurs. Jan = 0, Feb = 1 ..... Dec = 11 -
setMonth
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
Gets the day of the month on which the event occurs- Returns:
- an expression resolving to a number (integer) between 1 and 31
-
setDayOfMonthExpr
Sets the day of the month on which the event occurs- Parameters:
dayOfMonth_
- an expression resolving to a number (integer) between 1 and 31
-