flux
Interface ForecastIterator

public interface ForecastIterator

Indicates when some flow charts that contain Timer Triggers are expected to fire; YOU MUST CALL CLOSE() ON THIS ITERATOR WHEN YOU ARE FINISHED USING IT!

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

void	close() YOU MUST CALL CLOSE() ON THIS ITERATOR WHEN YOU ARE FINISHED USING IT!
boolean	hasNext() Indicates whether there are more forecast elements in this iterator.
ForecastElement	next() Returns the next forecast element in this forecast iterator.

Method Detail

close

void close()
           throws EngineException

YOU MUST CALL CLOSE() ON THIS ITERATOR WHEN YOU ARE FINISHED USING IT! After this iterator is closed, it can no longer be used.

Throws:

EngineException - If a system error occurs.

hasNext

boolean hasNext()
                throws EngineException

Indicates whether there are more forecast elements in this iterator.

Returns:

Whether there are more forecast elements in this iterator.

Throws:

EngineException - If a system error occurs.

next

ForecastElement next()
                     throws EngineException

Returns the next forecast element in this forecast iterator.

Returns:

The next forecast element in this iterator. Returns null if there are no more available forecast elements, which can happen if a flow chart is removed or its state has changed after the previous call to the hasNext() method but before the call to this next() method.

Throws:

EngineException - If a system error occurs.