Package com.appiancorp.suiteapi.process
Class RecurringInterval.Weekly
java.lang.Object
com.appiancorp.suiteapi.process.RecurringInterval.Weekly
- All Implemented Interfaces:
Serializable
- Enclosing class:
- RecurringInterval
Class that defines time interval for events that occur on a Weekly basis.
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionInteger[]
Returns an array of integer containing the days of the Week on which the event occurs.Return interval in number of weeks between two consecutive weeks on which event occurs.Gets interval in number of weeks between two consecutive weeks on which event occurs.void
setDaysOfWeek
(Integer[] daysOfWeek_) Sets days of week on which the event occurs.void
setWeekInterval
(Integer weekInterval_) Sets interval in number of weeks between two consecutive weeks on which event occurs.void
setWeekIntervalExpr
(String weekIntervalExpr_) Sets interval in number of weeks between two consecutive weeks on which event occurs.
-
Constructor Details
-
Weekly
public Weekly()
-
-
Method Details
-
getDaysOfWeek
Returns an array of integer containing the days of the Week on which the event occurs. Weekdays are represented by integers in the following way: SUNDAY = 1, MONDAY = 2, TUESDAY = 3, WEDNESDAY = 4, THURSDAY = 5, FRIDAY = 6, SATURDAY = 7. Hence if the event should occur every Monday and Thursday, it will represented by the following int[] = new int{2, 5}- Returns:
- integer array containing days of the week on which event occurs
-
setDaysOfWeek
Sets days of week on which the event occurs. The parameter is an array of integer containing the days of the Week on which the event occurs. Weekdays are represented by integers in the following way: SUNDAY = 1, MONDAY = 2, TUESDAY = 3, WEDNESDAY = 4, THURSDAY = 5, FRIDAY = 6, SATURDAY = 7. So if the event should occur every Monday and Thursday, it will represented by the following int[] = new int{2, 5} -
getWeekInterval
Return interval in number of weeks between two consecutive weeks on which event occurs. -
setWeekInterval
Sets interval in number of weeks between two consecutive weeks on which event occurs. -
getWeekIntervalExpr
Gets interval in number of weeks between two consecutive weeks on which event occurs.- Returns:
- an expression that resolves to a number (integer)
-
setWeekIntervalExpr
Sets interval in number of weeks between two consecutive weeks on which event occurs.- Parameters:
weekIntervalExpr_
- an expression that resolves to a number (integer)
-