Package com.appiancorp.suiteapi.process
Class RecurringInterval
java.lang.Object
com.appiancorp.suiteapi.process.RecurringInterval
- All Implemented Interfaces:
Serializable
Defines a time interval for an event that repeats after a fixed
delay. The delay can be specified as Daily, Weekly, Monthly, Yearly or
Interval
. This class is mainly used to specify the
Recurrence
property of a node.- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Class defines Daily recurring intervalstatic class
Class defines time interval for Monthly events.static class
Class that defines time interval for events that occur on a Weekly basis.static class
Class defines time interval for Yearly events. -
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
-
Constructor Summary
ConstructorDescriptionCreates a RecurringInterval object, without setting the RecurringInterval type.RecurringInterval
(int intervalType_) Creates a RecurringInterval object. -
Method Summary
Modifier and TypeMethodDescriptiongetDaily()
Returns the recurring daily intervalReturns theInterval
object.int
Returns the type of the RecurringIntervalGets the Monthly delaygetTime()
Gets the time of the day which the event occures.Gets the time of the day at which the event occurs.Gets the Weekly delayGets the Yearly delayvoid
setDaily
(RecurringInterval.Daily daily_) Sets the Daily intervalvoid
setInterval
(Interval interval_) Sets the delay with anInterval
objectvoid
setIntervalType
(int intervalType_) Sets the type of the RecurringIntervalvoid
setMonthly
(RecurringInterval.Monthly monthly_) Sets the Monthly delayvoid
Sets the time of the day, at which the event occurs.void
setTimeExpr
(String timeExpr_) Sets the time of the day at which the event occurs.void
setWeekly
(RecurringInterval.Weekly weekly_) Sets the Weekly delayvoid
setYearly
(RecurringInterval.Yearly yearly_) Sets the Yearly delay
-
Field Details
-
RECURRING_TYPE_INTERVAL
public static final int RECURRING_TYPE_INTERVAL- See Also:
-
RECURRING_TYPE_DAILY
public static final int RECURRING_TYPE_DAILY- See Also:
-
RECURRING_TYPE_WEEKLY
public static final int RECURRING_TYPE_WEEKLY- See Also:
-
RECURRING_TYPE_MONTHLY
public static final int RECURRING_TYPE_MONTHLY- See Also:
-
RECURRING_TYPE_YEARLY
public static final int RECURRING_TYPE_YEARLY- See Also:
-
-
Constructor Details
-
RecurringInterval
public RecurringInterval(int intervalType_) Creates a RecurringInterval object.- Parameters:
intervalType_
- type of the RecurringInterval- See Also:
-
RecurringInterval
public RecurringInterval()Creates a RecurringInterval object, without setting the RecurringInterval type.
-
-
Method Details
-
getIntervalType
public int getIntervalType()Returns the type of the RecurringInterval -
setIntervalType
public void setIntervalType(int intervalType_) Sets the type of the RecurringInterval- Parameters:
intervalType_
- one of the following: RECURRING_TYPE_INTERVAL, RECURRING_TYPE_DAILY, RECURRING_TYPE_WEEKLY, RECURRING_TYPE_MONTHLY, RECURRING_TYPE_YEARLY- Throws:
IllegalArgumentException
- if param is not one of the supported types.
-
getDaily
Returns the recurring daily interval- Returns:
- Daily object or null
-
setDaily
Sets the Daily interval -
getInterval
Returns theInterval
object.- See Also:
-
setInterval
Sets the delay with anInterval
object- See Also:
-
getMonthly
Gets the Monthly delay- See Also:
-
setMonthly
Sets the Monthly delay- See Also:
-
getWeekly
Gets the Weekly delay- See Also:
-
setWeekly
Sets the Weekly delay- See Also:
-
getYearly
Gets the Yearly delay- See Also:
-
setYearly
Sets the Yearly delay- See Also:
-
getTime
Gets the time of the day which the event occures. This time is significant only when theRecurringInterval
is of type RECURRING_TYPE_DAILY, RECURRING_TYPE_WEEKLY, RECURRING_TYPE_MONTHLY, RECURRING_TYPE_YEARLY.- Returns:
- Time used to fire the event. The actual time is calculated based on an specific TimeZone
-
setTime
Sets the time of the day, at which the event occurs. This time is significant only when theRecurringInterval
is of type RECURRING_TYPE_DAILY, RECURRING_TYPE_WEEKLY, RECURRING_TYPE_MONTHLY, RECURRING_TYPE_YEARLY.- Parameters:
Time
- used to fire the event
-
getTimeExpr
Gets the time of the day at which the event occurs. This time is significant only when theRecurringInterval
is of type RECURRING_TYPE_DAILY, RECURRING_TYPE_WEEKLY, RECURRING_TYPE_MONTHLY, RECURRING_TYPE_YEARLY.- Returns:
- a String expression that resolves to a time. The actual time is calculated based on an specific TimeZone
-
setTimeExpr
Sets the time of the day at which the event occurs. This time is significant only when theRecurringInterval
is of type RECURRING_TYPE_DAILY, RECURRING_TYPE_WEEKLY, RECURRING_TYPE_MONTHLY, RECURRING_TYPE_YEARLY.- Parameters:
time_
- String expression that resolves to a time
-