flux
Interface ActionHistoryIterator


public interface ActionHistoryIterator

Contains historical timestamps for actions or triggers in a flow chart. 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 action history elements in this iterator.
 ActionHistory next()
          Returns the next action history elements 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 action history elements in this iterator.

Returns:
Whether there are more action history elements in this iterator.
Throws:
EngineException - If a system error occurs.

next

ActionHistory next()
                   throws EngineException
Returns the next action history elements in this iterator.

Returns:
The next action history element in this iterator. Returns null if there are no more available action history elements, 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 action history element could not be retrieved.


© 2014 Flux Corporation. All rights reserved.