Documentation

Trace:

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
workflow:custom_function [2019/03/13 14:47]
admin
workflow:custom_function [2019/03/14 09:03]
admin
Line 8: Line 8:
 { {
     /**     /**
-     ​* ​The current workflow step. +     ​* ​Gets the current workflow step. 
-     * @return ​The current workflow step.+     ​* ​ 
 +     * @return ​the current workflow step.
      */      */
     public IWorkflowStep getWorkflowStep();​     public IWorkflowStep getWorkflowStep();​
Line 16: Line 17:
      * Initializes the function.      * Initializes the function.
      ​* ​      ​* ​
-     * @param ​pWorkflow ​the current workflow step+     * @param ​pStep the current workflow step
      */      */
-    public void init(IWorkflowStep ​pWorkflow);+    public void init(IWorkflowStep ​pStep);
  
     /**     /**
      * Runs the function.      * Runs the function.
-     * If the function returns true, the function is fully done, and the workflow jumps to the next step.+     * If the function returns ​<​code>​true</​code>​, the function is fully done, and the workflow jumps to the next step.
      * In case there are more then one next steps, the finish function of IWorkflowStep has to be called.      * In case there are more then one next steps, the finish function of IWorkflowStep has to be called.
      * An exception will be thrown otherwise.      * An exception will be thrown otherwise.
-     * If finish is already called, it does not matter whether true or false is returned.+     * If finish is already called, it does not matter whether ​<​code>​true</​code> ​or <​code>​false</​code> ​is returned.
      ​* ​      ​* ​
-     * @return true, if the function is done.+     * @return ​<​code>​true</​code>​, if the function is done.
      * @throws Throwable if function fails.      * @throws Throwable if function fails.
      */      */
Line 53: Line 54:
         if (smtp == null)          if (smtp == null) 
         {         {
-            throw new IllegalArgumentException("​SMTP config not found in config ​(path /​application/​mail/​smtp)!"​);​+            throw new IllegalArgumentException("​SMTP config not found (path /​application/​mail/​smtp)!"​);​
         }         }
  
Line 96: Line 97:
 {{:​workflow:​wf_emailfunction.png?​nolink|}} {{:​workflow:​wf_emailfunction.png?​nolink|}}
  
-That's it. Start using you new function. +That's it. Start using your new function.
- +
This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.More information