org.jwarp.flow.form
Interface IFormManager

All Superinterfaces:

IConfigurable, IWorkflowSystemAware

public interface IFormManager

extends IConfigurable, IWorkflowSystemAware

This is the interface of the form manager. The form manager is the controller managing the form and their status.

Method Summary

void	addFactory(IFormFactory factory, java.lang.String name, ITicket user) Adds a new form factory thus enabling to show a new form given the name provided.
void	configure(org.jdom.Element config) Parse the xml tree for initializing the manager.
IForm	createForm(java.lang.String name, IWorkflowContext context, ITicket user) Creates a new form.
java.util.Iterator	getFactoryNames() Get the names of all currently defined forms factories/forms.
void	removeAllFactories(ITicket user) Remove all forms.
void	removeFactory(java.lang.String name, ITicket user) Remove a form factory.

Methods inherited from interface org.jwarp.flow.IWorkflowSystemAware

getWorkflowSystem, setWorkflowSystem

Method Detail

configure

public void configure(org.jdom.Element config)
               throws ConfigurationException

Parse the xml tree for initializing the manager.

Specified by:

configure in interface IConfigurable

Parameters:

xml - The XML input

createForm

public IForm createForm(java.lang.String name,
                        IWorkflowContext context,
                        ITicket user)
                 throws FormInitException

Creates a new form.

Parameters:

name - The form (factory's) name

context - The actual workflow context

Returns:

The new form (not shown yet, but initialised)

addFactory

public void addFactory(IFormFactory factory,
                       java.lang.String name,
                       ITicket user)

Adds a new form factory thus enabling to show a new form given the name provided.

removeFactory

public void removeFactory(java.lang.String name,
                          ITicket user)

Remove a form factory. All following calls to such a form will end in a InternalError state.

removeAllFactories

public void removeAllFactories(ITicket user)

Remove all forms. All following calls to such a form will end in a InternalError state.

getFactoryNames

public java.util.Iterator getFactoryNames()

Get the names of all currently defined forms factories/forms.