com.appiancorp.suiteapi.process

Class RecurringInterval

java.lang.Object

com.appiancorp.suiteapi.process.RecurringInterval

All Implemented Interfaces:

java.io.Serializable

public class RecurringInterval
extends java.lang.Object
implements java.io.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:

Recurrence, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecurringInterval.Daily Class defines Daily recurring interval
static class	RecurringInterval.Monthly Class defines time interval for Monthly events.
static class	RecurringInterval.Weekly Class that defines time interval for events that occur on a Weekly basis.
static class	RecurringInterval.Yearly Class defines time interval for Yearly events.

Field Summary

Fields

Modifier and Type	Field and Description
static int	RECURRING_TYPE_DAILY
static int	RECURRING_TYPE_INTERVAL
static int	RECURRING_TYPE_MONTHLY
static int	RECURRING_TYPE_WEEKLY
static int	RECURRING_TYPE_YEARLY

Constructor Summary

Constructors

Constructor and Description
RecurringInterval() Creates a RecurringInterval object, without setting the RecurringInterval type.
RecurringInterval(int intervalType_) Creates a RecurringInterval object.

Method Summary

Modifier and Type	Method and Description
RecurringInterval.Daily	getDaily() Returns the recurring daily interval
Interval	getInterval() Returns the Interval object.
int	getIntervalType() Returns the type of the RecurringInterval
RecurringInterval.Monthly	getMonthly() Gets the Monthly delay
java.sql.Time	getTime() Gets the time of the day which the event occures.
java.lang.String	getTimeExpr() Gets the time of the day at which the event occurs.
RecurringInterval.Weekly	getWeekly() Gets the Weekly delay
RecurringInterval.Yearly	getYearly() Gets the Yearly delay
void	setDaily(RecurringInterval.Daily daily_) Sets the Daily interval
void	setInterval(Interval interval_) Sets the delay with an Interval object
void	setIntervalType(int intervalType_) Sets the type of the RecurringInterval
void	setMonthly(RecurringInterval.Monthly monthly_) Sets the Monthly delay
void	setTime(java.sql.Time time_) Sets the time of the day, at which the event occurs.
void	setTimeExpr(java.lang.String timeExpr_) Sets the time of the day at which the event occurs.
void	setWeekly(RecurringInterval.Weekly weekly_) Sets the Weekly delay
void	setYearly(RecurringInterval.Yearly yearly_) Sets the Yearly delay

Methods inherited from class java.lang.Object

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

Field Detail

RECURRING_TYPE_INTERVAL

public static final int RECURRING_TYPE_INTERVAL

See Also:

Constant Field Values

RECURRING_TYPE_DAILY

public static final int RECURRING_TYPE_DAILY

See Also:

Constant Field Values

RECURRING_TYPE_WEEKLY

public static final int RECURRING_TYPE_WEEKLY

See Also:

Constant Field Values

RECURRING_TYPE_MONTHLY

public static final int RECURRING_TYPE_MONTHLY

See Also:

Constant Field Values

RECURRING_TYPE_YEARLY

public static final int RECURRING_TYPE_YEARLY

See Also:

Constant Field Values

Constructor Detail

RecurringInterval

public RecurringInterval(int intervalType_)

Creates a RecurringInterval object.

Parameters:

intervalType_ - type of the RecurringInterval

See Also:

RECURRING_TYPE_INTERVAL, RECURRING_TYPE_DAILY, RECURRING_TYPE_WEEKLY, RECURRING_TYPE_MONTHLY, RECURRING_TYPE_YEARLY

RecurringInterval

public RecurringInterval()

Creates a RecurringInterval object, without setting the RecurringInterval type.

Method Detail

getIntervalType

public int getIntervalType()

Returns the type of the RecurringInterval

See Also:

RECURRING_TYPE_INTERVAL, RECURRING_TYPE_DAILY, RECURRING_TYPE_WEEKLY, RECURRING_TYPE_MONTHLY, RECURRING_TYPE_YEARLY

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:

java.lang.IllegalArgumentException - if param is not one of the supported types.

getDaily

public RecurringInterval.Daily getDaily()

Returns the recurring daily interval

Returns:

Daily object or null

setDaily

public void setDaily(RecurringInterval.Daily daily_)

Sets the Daily interval

getInterval

public Interval getInterval()

Returns the Interval object.

See Also:

Interval

setInterval

public void setInterval(Interval interval_)

Sets the delay with an Interval object

See Also:

Interval

getMonthly

public RecurringInterval.Monthly getMonthly()

Gets the Monthly delay

See Also:

RecurringInterval.Monthly

setMonthly

public void setMonthly(RecurringInterval.Monthly monthly_)

Sets the Monthly delay

See Also:

RecurringInterval.Monthly

getWeekly

public RecurringInterval.Weekly getWeekly()

Gets the Weekly delay

See Also:

RecurringInterval.Weekly

setWeekly

public void setWeekly(RecurringInterval.Weekly weekly_)

Sets the Weekly delay

See Also:

RecurringInterval.Weekly

getYearly

public RecurringInterval.Yearly getYearly()

Gets the Yearly delay

See Also:

RecurringInterval.Yearly

setYearly

public void setYearly(RecurringInterval.Yearly yearly_)

Sets the Yearly delay

See Also:

RecurringInterval.Yearly

getTime

public java.sql.Time getTime()

Gets the time of the day which the event occures. This time is significant only when the RecurringInterval 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

public void setTime(java.sql.Time time_)

Sets the time of the day, at which the event occurs. This time is significant only when the RecurringInterval is of type RECURRING_TYPE_DAILY, RECURRING_TYPE_WEEKLY, RECURRING_TYPE_MONTHLY, RECURRING_TYPE_YEARLY.

Parameters:

Time - used to fire the event

getTimeExpr

public java.lang.String getTimeExpr()

Gets the time of the day at which the event occurs. This time is significant only when the RecurringInterval 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

public void setTimeExpr(java.lang.String timeExpr_)

Sets the time of the day at which the event occurs. This time is significant only when the RecurringInterval is of type RECURRING_TYPE_DAILY, RECURRING_TYPE_WEEKLY, RECURRING_TYPE_MONTHLY, RECURRING_TYPE_YEARLY.

Parameters:

time_ - String expression that resolves to a time