View Javadoc

1   /*
2    *  DISCLAIMER
3    */
4   
5   package org.flowfuse.base.services.workflow.functions;
6   
7   /***
8    * Implementations of this class will be called before the workflow will be
9    * persisted.  Use this class to add some OS WorkflowInstance related data to your
10   * Payload.
11   * <p/>
12   * Define in the workflow descriptor which class to call:
13   * <code>
14   * &lt;function type="class"&gt;
15   *   &lt;arg name="class.name"&gt;de. ... .StoreWorkflowDataFunction&lt;/arg&gt;
16   *   &lt;arg name="payload.store.preprocessor"&gt;my.StorePayloadPreprocessor&lt;/arg&gt;
17   * &lt;/function&gt;
18   * </code>
19   *
20   * @author <a href="stefan@flowfuse.org">Stefan Kleineikenscheidt</a>,
21   *         Flowfuse.org
22   * @version $Id: StorePayloadPreprocessor.java,v 1.1 2005/11/20 15:02:22 skleinei Exp $
23   */
24  public interface StorePayloadPreprocessor {
25  
26    /* RCS ID */
27    public final static String rcsid = "$Id: StorePayloadPreprocessor.java,v 1.1 2005/11/20 15:02:22 skleinei Exp $";
28  
29    /***
30     * Implement this to do something with your payload before
31     * it is persisted. E.g. add some workflow information to the
32     * payload.
33     *
34     * @param payload
35     * @return
36     */
37    public Object processPayload(Object payload);
38  
39  }
40  
41  /* EOF */