Package com.appiancorp.suiteapi.process
Class Recurrence.End
java.lang.Object
com.appiancorp.suiteapi.process.Recurrence.End
- All Implemented Interfaces:
Serializable
- Enclosing class:
- Recurrence
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 Summary
Modifier and TypeFieldDescriptionstatic final int
End when expression evaluates to true.static final int
End when node recurs 'x' timesstatic final int
End at a specified time -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Deprecated.Gets the expression, which when true, stops the recurrence of the node.Deprecated.Deprecated.int
Returns the type of End conditionRetruns number of recurrence after which the recurrence ends.void
setEndDate
(Date endDate_) Deprecated.use {@link #setEndDateTimeExpr(String))}void
setEndDate
(Timestamp endDate_) Deprecated.use {@link #setEndDateTimeExpr(String))}void
setEndDateExpr
(String endDateExpr_) Deprecated.use {@link #setEndDateTimeExpr(String))}void
setEndDateTimeExpr
(String endDateTimeExpr) void
setEndExpression
(String endExpression_) Sets the expression, which when true, stops the recurrence of the node.void
setEndTime
(Time endTime_) Deprecated.use {@link #setEndDateTimeExpr(String))}void
setEndTime
(Timestamp endTime_) Deprecated.use {@link #setEndDateTimeExpr(String))}void
setEndTimeExpr
(String endTimeExpr_) Deprecated.use {@link #setEndDateTimeExpr(String))}void
setEndType
(int endType_) Sets the type of end conditionvoid
setNumOccurrences
(Integer numOccurrences_) Sets the number of occurrences after which the recurrence ends.
-
Field Details
-
END_ON_OCCURRENCE
public static final int END_ON_OCCURRENCEEnd when node recurs 'x' times- See Also:
-
END_ON_TIME
public static final int END_ON_TIMEEnd at a specified time- See Also:
-
END_ON_EXPRESSION
public static final int END_ON_EXPRESSIONEnd when expression evaluates to true.- See Also:
-
-
Constructor Details
-
End
public End()Creates an End object without setting the End type. -
End
Creates an End object.- Parameters:
endType_
- Type of the end condition.- Throws:
IllegalArgumentException
- See Also:
-
-
Method Details
-
getEndDateTimeExpr
-
setEndDateTimeExpr
-
getEndTime
Deprecated.Returns the time at which recurrence end- Returns:
- the timestamp of the end time, null if the time is not set
- See Also:
-
getNumOccurrences
Retruns number of recurrence after which the recurrence ends.- See Also:
-
setNumOccurrences
Sets the number of occurrences after which the recurrence ends.- Throws:
IllegalArgumentException
- if the number of occurrences in less than 1.
-
setEndTime
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.use {@link #setEndDateTimeExpr(String))} -
getEndExpression
Gets the expression, which when true, stops the recurrence of the node.- Returns:
- String representing the expression
-
setEndExpression
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.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.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.use {@link #setEndDateTimeExpr(String))} -
getEndDateExpr
Deprecated.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.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.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.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:
-
getEndDateTimeExpr()