flux
Interface ForecastElement
public interface ForecastElement
Contains information on when a flow chart is expected to fire.
- Author:
- Copyright 2014 Flux Corporation. All rights reserved.
Method Summary |
java.util.Date |
getEndDate()
Returns the date when the referenced timer trigger expires. |
java.lang.String |
getFlowChartName()
Returns the name of the flow chart that is expected to fire. |
java.util.Date |
getPredictedFiringDate()
Returns an expected firing time of the flow chart indicated by this
forecast element. |
long |
getRemainingCount()
Returns the number of remaining scheduled firings for the referenced timer
trigger. |
TimeExpression |
getTimeExpression()
Returns the time expression associated with the referenced timer trigger. |
java.lang.String |
getTimerTriggerName()
Returns the name of the timer trigger that was referenced when building
this forecast. |
getEndDate
java.util.Date getEndDate()
- Returns the date when the referenced timer trigger expires. Timer triggers
scheduled to fire on or after this date are expired. Returns null if there
is no expiration date. However, although an expiration date may not exist,
the referenced timer trigger may expire when its count is exhausted.
- Returns:
- The date when this timer trigger expires.
getFlowChartName
java.lang.String getFlowChartName()
- Returns the name of the flow chart that is expected to fire.
- Returns:
- The name of the flow chart that is expected to fire.
getPredictedFiringDate
java.util.Date getPredictedFiringDate()
- Returns an expected firing time of the flow chart indicated by this
forecast element. The returned date matches the scheduled trigger date on
the flow chart's timer trigger. Note that the actual firing times of flow
charts may not directly correspond with predicted firing dates due to a
variety of factors.
- Returns:
- An expected firing time of this flow chart.
getRemainingCount
long getRemainingCount()
- Returns the number of remaining scheduled firings for the referenced timer
trigger. Returns -1 if it is scheduled to fire indefinitely.
- Returns:
- The number of remaining scheduled firings for the referenced timer
trigger.
getTimeExpression
TimeExpression getTimeExpression()
- Returns the time expression associated with the referenced timer trigger.
- Returns:
- The time expression associated with the referenced timer trigger.
getTimerTriggerName
java.lang.String getTimerTriggerName()
- Returns the name of the timer trigger that was referenced when building
this forecast.
- Returns:
- The name of the timer trigger that was referenced when building
this forecast.
© 2014 Flux Corporation. All rights reserved.