EngineAccess.Data.Flow (Teneo Engine - Scripting API Javadoc 7.4.0-SP1 API)

All Known Subinterfaces:

EngineAccess.Data.ActiveFlow

Enclosing interface:

EngineAccess.Data
```
public static interface EngineAccess.Data.Flow
```
The data of a flow.

Since:

1.3.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getDescription()`	Returns the description text of this flow.
`String`	`getFolderPath()`	Returns the path of the solution folder this flow is stored in.
`String`	`getId()`	Returns the ID of this flow.
`Map<String,String>`	`getMetadata()`	Returns the metadata of this flow, including any default values.
`String`	`getName()`	Returns the name of this flow.
`String`	`getType()`	Returns the type of this flow.
`String`	`toString()`	Returns a human readable representation of this flow.

- Method Detail
  - getId
```
String getId()
```
    Returns the ID of this flow.
    
    Since:
    
    1.3.0
  - getName
```
String getName()
```
    Returns the name of this flow.
    
    Since:
    
    1.3.0
  - getType
```
String getType()
```
    Returns the type of this flow. The value is either "normal" for a normal flow, or "sub" for a subflow (invoked on behalf of a normal flow).
    
    Since:
    
    1.3.0
  - getDescription
```
String getDescription()
```
    Returns the description text of this flow.
    
    Since:
    
    1.3.0
  - getFolderPath
```
String getFolderPath()
```
    Returns the path of the solution folder this flow is stored in.
    
    Since:
    
    1.3.0
  - getMetadata
```
Map<String,String> getMetadata()
```
    Returns the metadata of this flow, including any default values.
    
    Returns:
    
    an unmodifiable Map containing the metadata name/value pairs
    
    Since:
    
    1.3.0
  - toString
```
String toString()
```
    Returns a human readable representation of this flow.
    
    Overrides:
    
    toString in class Object
    
    Since:
    
    1.3.0