org.jwarp.flow.form
Interface INavigationManager

All Superinterfaces:

IConfigurable, IWorkflowSystemAware

public interface INavigationManager

extends IConfigurable, IWorkflowSystemAware

The purpose of this class is to allow one to load and execute Navigation modules.

Version:

$Id: NavigationLoader.java,v 1.4 2000/10/04 20:35:17 gonzalo Exp $

Author:

Dave Bryson

Method Summary

void	addFactory(INavigationFactory factory, java.lang.String name, ITicket user) Adds a new navigation factory thus enabling to show a new navigation given the name provided.
void	configure(org.jdom.Element config) Parse the xml tree for initializing the manager.
INavigation	createNavigation(java.lang.String name, IWorkflowContext context, ITicket user) Creates a new navigation.
java.util.Iterator	getFactoryNames() Get the names of all currently defined navigation factories/navigations.
void	removeAllFactories(ITicket user) Remove all navigations.
void	removeFactory(java.lang.String name, ITicket user) Remove a navigation 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

createNavigation

public INavigation createNavigation(java.lang.String name,
                                    IWorkflowContext context,
                                    ITicket user)
                             throws FormInitException

Creates a new navigation.

Parameters:

name - The navigation (factory's) name

context - The actual workflow context

Returns:

The new navigation (not shown yet, but initialised)

addFactory

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

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

removeFactory

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

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

removeAllFactories

public void removeAllFactories(ITicket user)

Remove all navigations. All following calls to such a navigation will end in a InternalError state.

getFactoryNames

public java.util.Iterator getFactoryNames()

Get the names of all currently defined navigation factories/navigations.