FlowExecutionListeningSupporter (adams-pom 24.11.0-SNAPSHOT API)

All Known Implementing Classes:

DefaultFlowExecutionListeningSupporter, ExecuteActor, Flow
```
public interface FlowExecutionListeningSupporter
```
Interface for classes that support listening using FlowExecutionListener.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`canStartListeningAtRuntime()`	Returns whether listeners can be attached at runtime.
`FlowExecutionListener`	`getFlowExecutionListener()`	Returns the current listener in use.
`boolean`	`isFlowExecutionListeningEnabled()`	Returns whether flow execution listening is enabled.
`void`	`setFlowExecutionListener(FlowExecutionListener l)`	Sets the listener to use.
`void`	`setFlowExecutionListeningEnabled(boolean value)`	Sets whether flow execution listening is enabled.
`boolean`	`startListeningAtRuntime(FlowExecutionListener l)`	Attaches the listener and starts listening.

- Method Detail
  - setFlowExecutionListeningEnabled
```
void setFlowExecutionListeningEnabled(boolean value)
```
    Sets whether flow execution listening is enabled.
    
    Parameters:
    
    value - true if to enable listening
  - isFlowExecutionListeningEnabled
```
boolean isFlowExecutionListeningEnabled()
```
    Returns whether flow execution listening is enabled.
    
    Returns:
    
    true if listening is enabled
  - setFlowExecutionListener
```
void setFlowExecutionListener(FlowExecutionListener l)
```
    Sets the listener to use.
    
    Parameters:
    
    l - the listener to use
  - getFlowExecutionListener
```
FlowExecutionListener getFlowExecutionListener()
```
    Returns the current listener in use.
    
    Returns:
    
    the listener
  - canStartListeningAtRuntime
```
boolean canStartListeningAtRuntime()
```
    Returns whether listeners can be attached at runtime.
    
    Returns:
    
    true if listeners can be attached dynamically
  - startListeningAtRuntime
```
boolean startListeningAtRuntime(FlowExecutionListener l)
```
    Attaches the listener and starts listening.
    
    Parameters:
    
    l - the listener to attach and use immediately
    
    Returns:
    
    true if listening could be started successfully