Package com.appiancorp.suiteapi.process
Class Recurrence
java.lang.Object
com.appiancorp.suiteapi.process.Recurrence
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
RecurrenceInstance
Used to specify properties of a node that is set to re-execute
after every configurable interval of time. The class also provides a way to
specify the end condition on which the recurrence should stop.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Class defines condition under which Recurrence stops for a node in process. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetEnd()
Returns End object that defines the end condition of the Recurrance of the node.Gets the time interval between two consecutive recurrences of a node.Gets the TimeZone ID used to calculate the Time at which the event occurs.Gets the TimeZone ID expression used to calculate the Time at which the event occurs.void
setEnd
(Recurrence.End end_) Set the end condition for the Recurrence of a node to stop.void
setRecurringInterval
(RecurringInterval recurringInterval_) Sets the time interval between two consecutive recurrences of a node.void
setTimeZoneId
(String timeZoneId) Sets the TimeZone ID used to calculate the Time at which the event occurs.void
setTimeZoneIdExpr
(String timeZoneIdExpr) Sets the TimeZone ID expression used to calculate the Time at which the event occurs.
-
Constructor Details
-
Recurrence
public Recurrence()
-
-
Method Details
-
getEnd
Returns End object that defines the end condition of the Recurrance of the node.- See Also:
-
setEnd
Set the end condition for the Recurrence of a node to stop.- See Also:
-
getRecurringInterval
Gets the time interval between two consecutive recurrences of a node.- See Also:
-
setRecurringInterval
Sets the time interval between two consecutive recurrences of a node.- See Also:
-
getTimeZoneId
Gets the TimeZone ID used to calculate the Time at which the event occurs.- Returns:
- TimeZone ID
-
setTimeZoneId
Sets the TimeZone ID used to calculate the Time at which the event occurs.- Parameters:
timeZoneId
- TimeZone ID
-
getTimeZoneIdExpr
Gets the TimeZone ID expression used to calculate the Time at which the event occurs.- Returns:
- String expression that resolves to a TimeZone ID
-
setTimeZoneIdExpr
Sets the TimeZone ID expression used to calculate the Time at which the event occurs.- Parameters:
timeZoneIdExpr
- String expression that resolves to a TimeZone ID
-