Package com.appiancorp.suiteapi.process
Class RecurringInterval.Monthly
java.lang.Object
com.appiancorp.suiteapi.process.RecurringInterval.Monthly
- All Implemented Interfaces:
Serializable
- Enclosing class:
- RecurringInterval
Class defines time interval for Monthly events. Monthly events can occur
on a specific day of the month i.e. on "10th day of every 2 months" or
Monthly events can occur on a specific weekday of the month i.e. on
"SECOND Friday of every 2 months".
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the day of the month on which event occursGets the day of the month on which the event occursReturns the day of the week on which event occurs.Returns the interval in terms on number of months between two consecutive monthly events.Returns the interval in terms on number of months between two consecutive monthly events as an expressionboolean
Returns true if the Monthly events occur on a particular day of a week of month like "Third Wednesday of every month", else false.Returns the Week of the month on which the Monthly event occurs.void
setDayOfMonth
(Integer dayOfMonth_) sets the day of the month on which the event occursvoid
setDayOfMonthExpr
(String dayOfMonthExpr_) Sets the day of the month on which the event occursvoid
setDayOfWeek
(Integer dayOfWeek_) Sets the day of the day of the week on which event occurs.void
setMonthInterval
(Integer monthInterval_) Sets the interval in terms on number of months between two consecutive monthly events.void
setMonthIntervalExpr
(String monthIntervalExpr_) Sets the interval in terms on number of months between two consecutive monthly events as an expressionvoid
setWeekdayBased
(boolean weekdayBased_) Set to true if the Monthly events occur on a particular day of a week of month like "Third Wednesday of every month", else false.void
setWeekType
(Integer dayType_) Sets the Week of the month on which the Monthly event occurs.
-
Field Details
-
WEEK_FIRST
public static final int WEEK_FIRST- See Also:
-
WEEK_SECOND
public static final int WEEK_SECOND- See Also:
-
WEEK_THIRD
public static final int WEEK_THIRD- See Also:
-
WEEK_FOURTH
public static final int WEEK_FOURTH- See Also:
-
WEEK_LAST
public static final int WEEK_LAST- See Also:
-
-
Constructor Details
-
Monthly
public Monthly()Creates a new object of type Monthly -
Monthly
public Monthly(boolean weekdayBased_) Creates a new Object of type Monthly.- Parameters:
weekdayBased_
- if true then the monthly events are of like "SECOND Friday of every 2 months" else the monthly events are like "10th day of every 2 months".
-
-
Method Details
-
getDayOfMonth
Returns the day of the month on which event occurs- Returns:
- 1 - 31
-
setDayOfMonth
sets the day of the month on which the event occurs- Parameters:
dayOfMonth_
- 1 - 31
-
getDayOfWeek
Returns 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 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
Returns the Week of the month on which the Monthly event occurs. This property is used to specify monthly event like "Third Wednesday of every month".- See Also:
-
setWeekType
Sets the Week of the month on which the Monthly event occurs. This property is used to specify monthly event like "Third Wednesday of every month".- See Also:
-
getMonthInterval
Returns the interval in terms on number of months between two consecutive monthly events. -
setMonthInterval
Sets the interval in terms on number of months between two consecutive monthly events. -
getWeekdayBased
public boolean getWeekdayBased()Returns true if the Monthly events occur on a particular day of a week of month like "Third Wednesday of every month", else false. -
setWeekdayBased
public void setWeekdayBased(boolean weekdayBased_) Set to true if the Monthly events occur on a particular day of a week of month like "Third Wednesday of every month", else false. -
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
-
getMonthIntervalExpr
Returns the interval in terms on number of months between two consecutive monthly events as an expression- Returns:
- an expression that evaluates to a number (integer)
-
setMonthIntervalExpr
Sets the interval in terms on number of months between two consecutive monthly events as an expression- Parameters:
monthIntervalExpr_
- an expression that evaluates to a number (integer)
-