Package com.appiancorp.suiteapi.process

Class Recurrence.End

java.lang.Object
com.appiancorp.suiteapi.process.Recurrence.End
All Implemented Interfaces:
Serializable
Enclosing class:
Recurrence
public static class Recurrence.End extends Object implements Serializable
Class defines condition under which Recurrence stops for a node in process.

The end condition can be one the following :
END_ON_OCCURRENCE i.e. end when node recurs 'x' times
END_ON_TIME i.e. end recurrence at Jan 1st 2005
END_ON_EXRESSION i.e. end when the expression evaluates to true.

See Also:

  • Field Details

    • END_ON_OCCURRENCE

      public static final int END_ON_OCCURRENCE
      End when node recurs 'x' times
      See Also:

    • END_ON_TIME

      public static final int END_ON_TIME
      End at a specified time
      See Also:

    • END_ON_EXPRESSION

      public static final int END_ON_EXPRESSION
      End when expression evaluates to true.
      See Also:

  • Constructor Details

  • Method Details

    • getEndDateTimeExpr

      public String getEndDateTimeExpr()

    • setEndDateTimeExpr

      public void setEndDateTimeExpr(String endDateTimeExpr)

    • getEndTime

      @Deprecated public Time getEndTime()
      Deprecated.
      use getEndDateTimeExpr()
      Returns the time at which recurrence end
      Returns:
      the timestamp of the end time, null if the time is not set
      See Also:

    • getNumOccurrences

      public Integer getNumOccurrences()
      Retruns number of recurrence after which the recurrence ends.
      See Also:

    • setNumOccurrences

      public void setNumOccurrences(Integer numOccurrences_)
      Sets the number of occurrences after which the recurrence ends.
      Throws:
      IllegalArgumentException - if the number of occurrences in less than 1.

    • setEndTime

      @Deprecated public void setEndTime(Timestamp endTime_)
      Deprecated.
      use {@link #setEndDateTimeExpr(String))}
      Sets the time at which recurrence ends
      Parameters:
      endTime_ - Timestamp representing the date and time at which recurrence should end.
      See Also:

    • setEndTime

      @Deprecated public void setEndTime(Time endTime_)
      Deprecated.
      use {@link #setEndDateTimeExpr(String))}

    • getEndExpression

      public String getEndExpression()
      Gets the expression, which when true, stops the recurrence of the node.
      Returns:
      String representing the expression

    • setEndExpression

      public void setEndExpression(String endExpression_)
      Sets the expression, which when true, stops the recurrence of the node.
      Parameters:
      endExpression_ - String representing the expression

    • getEndType

      public int getEndType()
      Returns the type of End condition
      See Also:

    • setEndType

      public void setEndType(int endType_)
      Sets the type of end condition
      See Also:

    • getEndDate

      @Deprecated public Date getEndDate()
      Deprecated.
      use getEndDateTimeExpr()
      Gets the date on which recurrence ends, if such a date has been configured with a TImestamp. Only the date portion of the timestamp is used.
      Returns:
      date at which recurrence should end (combined with endTime or endTimeExpr).
      See Also:

    • setEndDate

      @Deprecated public void setEndDate(Timestamp endDate_)
      Deprecated.
      use {@link #setEndDateTimeExpr(String))}
      Sets the date on which recurrence ends. Only the date portion of the timestamp is used.
      Parameters:
      endDate_ - date at which recurrence should end (combined with endTime or endTimeExpr).
      See Also:

    • setEndDate

      @Deprecated public void setEndDate(Date endDate_)
      Deprecated.
      use {@link #setEndDateTimeExpr(String))}

    • getEndDateExpr

      @Deprecated public String getEndDateExpr()
      Deprecated.
      use getEndDateTimeExpr()
      Gets the date on which recurrence ends, if such a date has been configured with an expression
      Returns:
      String that evaluates to a date at which recurrence should end (combined with endTime or endTimeExpr).
      See Also:

    • setEndDateExpr

      @Deprecated public void setEndDateExpr(String endDateExpr_)
      Deprecated.
      use {@link #setEndDateTimeExpr(String))}
      Sets the date on which recurrence ends (as an expression)
      Parameters:
      endDateExpr_ - String that evaluates to a date at which recurrence should end (combined with endTime or endTimeExpr).
      See Also:

    • getEndTimeExpr

      @Deprecated public String getEndTimeExpr()
      Deprecated.
      use getEndDateTimeExpr()
      Gets the time at which recurrence ends, if such a time has been configured with an expression
      Returns:
      String that evaluates to a time at which recurrence should end (combined with endDate or endDateExpr).
      See Also:

    • setEndTimeExpr

      @Deprecated public void setEndTimeExpr(String endTimeExpr_)
      Deprecated.
      use {@link #setEndDateTimeExpr(String))}
      Sets the time at which recurrence ends
      Parameters:
      endTime_ - String that evaluates to a time at which recurrence should end (combined with endDate or endDateExpr).
      See Also: