flux
Interface FlowChartElementIterator

public interface FlowChartElementIterator

Contains multiple flow chart elements that are retrieved from a Flux engine; 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 charts in this iterator.
FlowChartElement	next() Returns the next flow chart element 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 charts in this iterator.

Returns:

Whether there are more flow charts in this iterator.

Throws:

EngineException - If a system error occurs.

next

FlowChartElement next()
                      throws EngineException

Returns the next flow chart element in this iterator.

Returns:

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

Throws:

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