com.appiancorp.suiteapi.process

Class Recurrence.End

java.lang.Object

com.appiancorp.suiteapi.process.Recurrence.End

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Recurrence

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

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	END_ON_EXPRESSION End when expression evaluates to true.
static int	END_ON_OCCURRENCE End when node recurs 'x' times
static int	END_ON_TIME End at a specified time

Constructor Summary

Constructors

Constructor and Description
End() Creates an End object without setting the End type.
End(int endType_) Creates an End object.

Method Summary

Modifier and Type	Method and Description
java.sql.Date	getEndDate() Deprecated. use getEndDateTimeExpr()
java.lang.String	getEndDateExpr() Deprecated. use getEndDateTimeExpr()
java.lang.String	getEndDateTimeExpr()
java.lang.String	getEndExpression() Gets the expression, which when true, stops the recurrence of the node.
java.sql.Time	getEndTime() Deprecated. use getEndDateTimeExpr()
java.lang.String	getEndTimeExpr() Deprecated. use getEndDateTimeExpr()
int	getEndType() Returns the type of End condition
java.lang.Integer	getNumOccurrences() Retruns number of recurrence after which the recurrence ends.
void	setEndDate(java.sql.Date endDate_) Deprecated. use #setEndDateTimeExpr(String))
void	setEndDate(java.sql.Timestamp endDate_) Deprecated. use #setEndDateTimeExpr(String))
void	setEndDateExpr(java.lang.String endDateExpr_) Deprecated. use #setEndDateTimeExpr(String))
void	setEndDateTimeExpr(java.lang.String endDateTimeExpr)
void	setEndExpression(java.lang.String endExpression_) Sets the expression, which when true, stops the recurrence of the node.
void	setEndTime(java.sql.Time endTime_) Deprecated. use #setEndDateTimeExpr(String))
void	setEndTime(java.sql.Timestamp endTime_) Deprecated. use #setEndDateTimeExpr(String))
void	setEndTimeExpr(java.lang.String endTimeExpr_) Deprecated. use #setEndDateTimeExpr(String))
void	setEndType(int endType_) Sets the type of end condition
void	setNumOccurrences(java.lang.Integer numOccurrences_) Sets the number of occurrences after which the recurrence ends.

Methods inherited from class java.lang.Object

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

Field Detail

END_ON_OCCURRENCE

public static final int END_ON_OCCURRENCE

End when node recurs 'x' times

See Also:

Constant Field Values

END_ON_TIME

public static final int END_ON_TIME

End at a specified time

See Also:

Constant Field Values

END_ON_EXPRESSION

public static final int END_ON_EXPRESSION

End when expression evaluates to true.

See Also:

Constant Field Values

Constructor Detail

End

public End()

Creates an End object without setting the End type.

End

public End(int endType_)
    throws java.lang.IllegalArgumentException

Creates an End object.

Parameters:

endType_ - Type of the end condition.

Throws:

java.lang.IllegalArgumentException

See Also:

END_ON_OCCURRENCE, END_ON_TIME, END_ON_EXPRESSION

Method Detail

getEndDateTimeExpr

public java.lang.String getEndDateTimeExpr()

setEndDateTimeExpr

public void setEndDateTimeExpr(java.lang.String endDateTimeExpr)

getEndTime

@Deprecated
public java.sql.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:

END_ON_TIME

getNumOccurrences

public java.lang.Integer getNumOccurrences()

Retruns number of recurrence after which the recurrence ends.

See Also:

END_ON_OCCURRENCE

setNumOccurrences

public void setNumOccurrences(java.lang.Integer numOccurrences_)

Sets the number of occurrences after which the recurrence ends.

Throws:

java.lang.IllegalArgumentException - if the number of occurrences in less than 1.

setEndTime

@Deprecated
public void setEndTime(java.sql.Timestamp endTime_)

Deprecated. use #setEndDateTimeExpr(String))

Sets the time at which recurrence ends

Parameters:

endTime_ - Timestamp representing the date and time at which recurrence should end.

See Also:

END_ON_TIME

setEndTime

@Deprecated
public void setEndTime(java.sql.Time endTime_)

Deprecated. use #setEndDateTimeExpr(String))

getEndExpression

public java.lang.String getEndExpression()

Gets the expression, which when true, stops the recurrence of the node.

Returns:

String representing the expression

setEndExpression

public void setEndExpression(java.lang.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:

END_ON_OCCURRENCE, END_ON_TIME, END_ON_EXPRESSION

setEndType

public void setEndType(int endType_)

Sets the type of end condition

See Also:

END_ON_OCCURRENCE, END_ON_TIME, END_ON_EXPRESSION

getEndDate

@Deprecated
public java.sql.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:

END_ON_TIME

setEndDate

@Deprecated
public void setEndDate(java.sql.Timestamp endDate_)

Deprecated. use #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:

END_ON_TIME

setEndDate

@Deprecated
public void setEndDate(java.sql.Date endDate_)

Deprecated. use #setEndDateTimeExpr(String))

getEndDateExpr

@Deprecated
public java.lang.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:

END_ON_TIME

setEndDateExpr

@Deprecated
public void setEndDateExpr(java.lang.String endDateExpr_)

Deprecated. use #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:

END_ON_TIME

getEndTimeExpr

@Deprecated
public java.lang.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:

END_ON_TIME

setEndTimeExpr

@Deprecated
public void setEndTimeExpr(java.lang.String endTimeExpr_)

Deprecated. use #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:

END_ON_TIME