com.appiancorp.suiteapi.process

Class Recurrence

java.lang.Object

com.appiancorp.suiteapi.process.Recurrence

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

RecurrenceInstance

public class Recurrence
extends java.lang.Object
implements java.io.Serializable

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Recurrence.End Class defines condition under which Recurrence stops for a node in process.

Constructor Summary

Constructors

Constructor and Description
Recurrence()

Method Summary

Modifier and Type	Method and Description
Recurrence.End	getEnd() Returns End object that defines the end condition of the Recurrance of the node.
RecurringInterval	getRecurringInterval() Gets the time interval between two consecutive recurrences of a node.
java.lang.String	getTimeZoneId() Gets the TimeZone ID used to calculate the Time at which the event occurs.
java.lang.String	getTimeZoneIdExpr() 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(java.lang.String timeZoneId) Sets the TimeZone ID used to calculate the Time at which the event occurs.
void	setTimeZoneIdExpr(java.lang.String timeZoneIdExpr) Sets the TimeZone ID expression used to calculate the Time at which the event occurs.

Methods inherited from class java.lang.Object

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

Constructor Detail

Recurrence

public Recurrence()

Method Detail

getEnd

public Recurrence.End getEnd()

Returns End object that defines the end condition of the Recurrance of the node.

See Also:

Recurrence.End

setEnd

public void setEnd(Recurrence.End end_)

Set the end condition for the Recurrence of a node to stop.

See Also:

Recurrence.End

getRecurringInterval

public RecurringInterval getRecurringInterval()

Gets the time interval between two consecutive recurrences of a node.

See Also:

RecurringInterval

setRecurringInterval

public void setRecurringInterval(RecurringInterval recurringInterval_)

Sets the time interval between two consecutive recurrences of a node.

See Also:

RecurringInterval

getTimeZoneId

public java.lang.String getTimeZoneId()

Gets the TimeZone ID used to calculate the Time at which the event occurs.

Returns:

TimeZone ID

setTimeZoneId

public void setTimeZoneId(java.lang.String timeZoneId)

Sets the TimeZone ID used to calculate the Time at which the event occurs.

Parameters:

timeZoneId - TimeZone ID

getTimeZoneIdExpr

public java.lang.String 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

public void setTimeZoneIdExpr(java.lang.String timeZoneIdExpr)

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