org.jwarp.flow.form
Interface IScreenManager

All Superinterfaces:

IConfigurable, IWorkflowSystemAware

public interface IScreenManager

extends IConfigurable, IWorkflowSystemAware

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

Method Summary

void	addFactory(IScreenFactory factory, java.lang.String name, ITicket user) Adds a new screen factory thus enabling to show a new screen given the name provided.
void	configure(org.jdom.Element config) Parse the xml tree for initializing the manager.
IScreen	createScreen(java.lang.String name, IWorkflowContext context, ITicket user) Creates a new screen.
java.util.Iterator	getFactoryNames() Get the names of all currently defined screen factories/screens.
java.lang.String	getMapping() Get the mapping engine description.
void	removeAllFactories(ITicket user) Remove all screens.
void	removeFactory(java.lang.String name, ITicket user) Remove a screen factory.
void	setMapping(java.lang.String mapping) Set the mapping engine description.

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

createScreen

public IScreen createScreen(java.lang.String name,
                            IWorkflowContext context,
                            ITicket user)
                     throws FormInitException

Creates a new screen.

Parameters:

name - The screen (factory's) name

context - The actual workflow context

Returns:

The new screen (not shown yet, but initialised)

addFactory

public void addFactory(IScreenFactory factory,
                       java.lang.String name,
                       ITicket user)
                throws java.lang.SecurityException

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

removeFactory

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

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

removeAllFactories

public void removeAllFactories(ITicket user)
                        throws java.lang.SecurityException

Remove all screens. All following calls to such a screen will end in a InternalError state.

getFactoryNames

public java.util.Iterator getFactoryNames()

Get the names of all currently defined screen factories/screens.

setMapping

public void setMapping(java.lang.String mapping)

Set the mapping engine description.

Parameters:

A - description how the resulting xml has to be mapped. There are mainly two mapping schemes to be defined:
1. The XML/XSLT/HTML mapping: 2. The XML/XSLT?/Swing mapping: The mapping should be implemented by the xml server package

getMapping

public java.lang.String getMapping()

Get the mapping engine description.

Returns:

A description how the resulting xml has to be mapped. There are mainly two mapping schemes to be defined:
1. The XML/XSLT/HTML mapping: 2. The XML/XSLT?/Swing mapping: The mapping should be implemented by the xml server package