KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > opensymphony > workflow > Register


1 /*
2  * Copyright (c) 2002-2003 by OpenSymphony
3  * All rights reserved.
4  */
5 package com.opensymphony.workflow;
6
7 import com.opensymphony.workflow.spi.WorkflowEntry;
8
9 import java.util.Map JavaDoc;
10
11
12 /**
13  * Interface that must be implemented for workflow registers to behave properly.
14  *
15  * @author <a HREF="mailto:plightbo@hotmail.com">Patrick Lightbody</a>
16  * @version $Revision: 1.2 $
17  */
18 public interface Register {
19     //~ Methods ////////////////////////////////////////////////////////////////
20
21     /**
22      * Returns the object to bind to the variable map for this workflow instance.
23      *
24      * @param context The current workflow context
25      * @param entry The workflow entry. Note that this might be null, for example in a pre function
26      * before the workflow has been initialised
27      * @param args Map of arguments as set in the workflow descriptor
28
29      * @return the object to bind to the variable map for this workflow instance
30      */
31     public Object JavaDoc registerVariable(WorkflowContext context, WorkflowEntry entry, Map JavaDoc args) throws WorkflowException;
32 }
33
Popular Tags