Trace:
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
workflow:documentation [2022/03/30 21:48] robot |
workflow:documentation [2022/03/30 22:14] (current) robot |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| ~~Title: Workflow engine Documentation~~ | ~~Title: Workflow engine Documentation~~ | ||
| - | Version: 1.0 / 2022-03-30 | + | Version: 1.0 / 2022-03-31 |
| ====== Introduction ====== | ====== Introduction ====== | ||
| Line 709: | Line 709: | ||
| A function is the code block behind a task. It is very simple to create a new function because a function is defined as a simple Java interface: | A function is the code block behind a task. It is very simple to create a new function because a function is defined as a simple Java interface: | ||
| - | <code> | + | <code java> |
| public interface IFunction | public interface IFunction | ||
| { | { | ||
| Line 728: | Line 728: | ||
| /** | /** | ||
| * Runs the function. | * Runs the function. | ||
| - | * If the function returns <code>true</code>, the function is fully done, and the workflow jumps to the next step. | + | * If the function returns {@code true}, the function is fully done, and the workflow jumps to the next step. |
| * In case there are more than one next step, the finish function of IWorkflowStep has to be called. | * In case there are more than one next step, the finish function of IWorkflowStep has to be called. | ||
| * Otherwise, an exception will be thrown. | * Otherwise, an exception will be thrown. | ||
| - | * If finish is already called, it does not matter whether <code>true</code> or <code>false</code> is returned. | + | * If finish is already called, it does not matter whether {@code true} or {@code false} is returned. |
| * | * | ||
| - | * @return <code>true</code>, if the function is done. | + | * @return {@code true}, if the function is done. |
| * @throws Throwable if function fails. | * @throws Throwable if function fails. | ||
| */ | */ | ||
| Line 748: | Line 748: | ||
| The interface already has an abstract implementation, so it is really simple to create a new function. Our example will send an email, so it's the EmailFunction: | The interface already has an abstract implementation, so it is really simple to create a new function. Our example will send an email, so it's the EmailFunction: | ||
| - | <code> | + | <code java> |
| public class EmailFunction extends AbstractFunction | public class EmailFunction extends AbstractFunction | ||
| { | { | ||
| Line 795: | Line 795: | ||
| The email settings will be read from the application configuration (config.xml file). | The email settings will be read from the application configuration (config.xml file). | ||
| - | <code> | + | <code xml> |
| <application> | <application> | ||
| ... | ... | ||