flux
Interface FlowChartRunIterator

public interface FlowChartRunIterator

Contains multiple flow chart runs. 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 flow chart runs in this iterator.
FlowChartRun	next() Returns the next flow chart run in this 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 flow chart runs in this iterator.

Returns:

Whether there are more flow chart runs in this iterator.

Throws:

EngineException - If a system error occurs.

next

FlowChartRun next()
                  throws EngineException

Returns the next flow chart run in this iterator.

Returns:

The next flow chart run in this iterator. Returns null if there are no more available flow chart runs, which can happen if a run is cleared from the run history due to audit trail expiration after the previous call to the hasNext() method but before the call to this next() method.

Throws:

EngineException - If the next flow chart run could not be retrieved.