org.jwarp.service.flow
Interface IScreenService

All Superinterfaces:

IConfigurable, IExceptionProvider, IService

public interface IScreenService

extends IService

Field Summary

static java.lang.String

SERVICE_TYPE

Fields inherited from interface org.jwarp.service.IService

SERVICE_STATUS_CREATED, SERVICE_STATUS_NOT_AVAILABLE, SERVICE_STATUS_READY, SERVICE_STATUS_RESUMING, SERVICE_STATUS_RUNNING, SERVICE_STATUS_STARTING, SERVICE_STATUS_STOPPED, SERVICE_STATUS_STOPPING, SERVICE_STATUS_SUSPENDED

Method Summary

IScreen	getActiveScreen(java.lang.String id, IWorkflowContext context) Return the active screen instance given the id.
java.util.Iterator	getActiveScreenInstances() Get all currently active/available screen instances.
void	showScreen(IScreen screen, IWorkflowContext context, ITicket user) Shows the given screen instance.

Methods inherited from interface org.jwarp.service.IService

checkContext, getDependencies, getLogLevel, getName, getStatus, getType, resume, setContext, setDependencies, setLogLevel, shutdown, start, suspend

Methods inherited from interface org.jwarp.service.configuration.IConfigurable

configure

Methods inherited from interface org.jwarp.common.IExceptionProvider

addExceptionListener, getExceptionListeners, removeAllExceptionListeners, removeExceptionListener

Field Detail

SERVICE_TYPE

public static final java.lang.String SERVICE_TYPE

Method Detail

getActiveScreen

public IScreen getActiveScreen(java.lang.String id,
                               IWorkflowContext context)
                        throws NotFoundException

Return the active screen instance given the id. The active screen instances are stored within the current workflow context This methods tries to extract the required screen instance. If no such instance is existing a FormInitException will be thrown. This method is also used by the web environment to dispatch http requests.

Parameters:

id - The screen name

context - The Workflow context

Returns:

The screen instance.

Throws:

FormInitException - If no such screen is present

showScreen

public void showScreen(IScreen screen,
                       IWorkflowContext context,
                       ITicket user)
                throws FormInitException

Shows the given screen instance. This will lead in creating a new real time job for the job scheduler who actually will map and show up the screen.

Parameters:

The - screen to cancel

The - user or admin user

getActiveScreenInstances

public java.util.Iterator getActiveScreenInstances()

Get all currently active/available screen instances.

Returns:

The screens