01: /*
02: * Copyright (c) 2002-2003 by OpenSymphony
03: * All rights reserved.
04: */
05: package com.opensymphony.workflow;
06:
07: import com.opensymphony.module.propertyset.PropertySet;
08:
09: import com.opensymphony.workflow.spi.WorkflowEntry;
10:
11: import java.util.Map;
12:
13: /**
14: * Interface that must be implemented for workflow registers to behave properly.
15: *
16: * @author <a href="mailto:plightbo@hotmail.com">Patrick Lightbody</a>
17: * @version $Revision: 1.3 $
18: */
19: public interface Register {
20: //~ Methods ////////////////////////////////////////////////////////////////
21:
22: /**
23: * Returns the object to bind to the variable map for this workflow instance.
24: *
25: * @param context The current workflow context
26: * @param entry The workflow entry. Note that this might be null, for example in a pre function
27: * before the workflow has been initialised
28: * @param args Map of arguments as set in the workflow descriptor
29:
30: * @param ps
31: * @return the object to bind to the variable map for this workflow instance
32: */
33: public Object registerVariable(WorkflowContext context,
34: WorkflowEntry entry, Map args, PropertySet ps)
35: throws WorkflowException;
36: }
|