Package com.appiancorp.suiteapi.process

Class RecurringInterval

java.lang.Object
com.appiancorp.suiteapi.process.RecurringInterval
All Implemented Interfaces:
Serializable
public class RecurringInterval extends Object implements 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:

  • Field Details

  • Constructor Details

  • Method Details

    • getIntervalType

      public int getIntervalType()
      Returns the type of the RecurringInterval
      See Also:

    • 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

      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:

    • setInterval

      public void setInterval(Interval interval_)
      Sets the delay with an Interval object
      See Also:

    • getMonthly

      public RecurringInterval.Monthly getMonthly()
      Gets the Monthly delay
      See Also:

    • setMonthly

      public void setMonthly(RecurringInterval.Monthly monthly_)
      Sets the Monthly delay
      See Also:

    • getWeekly

      public RecurringInterval.Weekly getWeekly()
      Gets the Weekly delay
      See Also:

    • setWeekly

      public void setWeekly(RecurringInterval.Weekly weekly_)
      Sets the Weekly delay
      See Also:

    • getYearly

      public RecurringInterval.Yearly getYearly()
      Gets the Yearly delay
      See Also:

    • setYearly

      public void setYearly(RecurringInterval.Yearly yearly_)
      Sets the Yearly delay
      See Also:

    • getTime

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