Package com.appiancorp.suiteapi.process

Class RecurringInterval.Weekly

java.lang.Object

com.appiancorp.suiteapi.process.RecurringInterval.Weekly

All Implemented Interfaces:

Serializable

Enclosing class:

RecurringInterval

public static class RecurringInterval.Weekly
extends Object
implements Serializable

Class that defines time interval for events that occur on a Weekly basis.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Weekly()

Method Summary

Modifier and Type	Method	Description
Integer[]	getDaysOfWeek()	Returns an array of integer containing the days of the Week on which the event occurs.
Integer	getWeekInterval()	Return interval in number of weeks between two consecutive weeks on which event occurs.
String	getWeekIntervalExpr()	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.

Methods inherited from class java.lang.Object

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

Constructor Details

Weekly

public Weekly()

Method Details

getDaysOfWeek

public Integer[] 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

public void setDaysOfWeek(Integer[] daysOfWeek_)

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

public Integer getWeekInterval()

Return interval in number of weeks between two consecutive weeks on which event occurs.

setWeekInterval

public void setWeekInterval(Integer weekInterval_)

Sets interval in number of weeks between two consecutive weeks on which event occurs.

getWeekIntervalExpr

public String 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

public void setWeekIntervalExpr(String weekIntervalExpr_)

Sets interval in number of weeks between two consecutive weeks on which event occurs.

Parameters:

weekIntervalExpr_ - an expression that resolves to a number (integer)