net.infordata.ifw2.web.ctrl

Interface IFlow

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IBndsFlow, ICard, IFlowUriDependent

All Known Implementing Classes:

ABndsFlow, ADataGridFlow, AGridFlow, BndsFlow, CalendarAction.MyCalendarFlow, CalendarFlow, CardFlow, DataGridFlow, DefaultPopupFlow, DialogBoxFlow, EditableGridFlow, FilterDefDlg, Flow, LayoutDefDlg, MenuBarFlow, MessageAreaFlow, MultiSelectionGridFlow, MultiSelectionListFlow, PojoLookupFlow, PojoMultiSelectionListFlow, PopupMenuFlow, TabbedFlow, TaskBoxFlow, TreeGridFlow

public interface IFlow
extends java.io.Serializable

A flow is a set of IFlowState, one of them is the current one.

Author:

valentino.proietti

Method Summary

Methods

Modifier and Type	Method and Description
IFlowComponent	asComponent(Flow parent, java.lang.String id) Acquires an IFlowComponent personality. Once acquired it cannot be changed, the same personality instance will be returned.
IFlowAsDialog	asDialog(java.lang.String title) Acquires an IFlowAsDialog personality. Once acquired it cannot be changed, the same personality instance will be returned.
IFlowAsState	asState(java.lang.String id) Acquires an IFlowAsState personality. Once acquired it cannot be changed, the same personality instance will be returned.
boolean	ensureStartup() Called to ensure that the flow has-been started.
IFlowState	getCurrentState()
IFlowPersonality	getFlowPersonality() The flow personality.
java.lang.String	getFocusCandidateName() see FlowContext.flowRequiresFocus(String).
java.lang.String	getLastActiveFieldName()
java.lang.String	getLastActiveFormName()
IFlowState	getPreviousState()
IFlowState	getState(java.lang.String id)
boolean	restartIfEnded() Restarts the flow only if it is ended. Subflows and flow components are forced to restart also.

Method Detail

ensureStartup

boolean ensureStartup()

Called to ensure that the flow has-been started.

Returns:

true if it has been started now.

restartIfEnded

boolean restartIfEnded()

Restarts the flow only if it is ended.
Subflows and flow components are forced to restart also.

Returns:

true if the flow has been restarted

getCurrentState

IFlowState getCurrentState()

Returns:

The current state even if not started yet.

getPreviousState

IFlowState getPreviousState()

getState

IFlowState getState(java.lang.String id)

getFlowPersonality

IFlowPersonality getFlowPersonality()

The flow personality.

asDialog

IFlowAsDialog asDialog(java.lang.String title)

Acquires an IFlowAsDialog personality.
Once acquired it cannot be changed, the same personality instance will be returned.

Parameters:

title - - null if none.

asState

IFlowAsState asState(java.lang.String id)

Acquires an IFlowAsState personality.
Once acquired it cannot be changed, the same personality instance will be returned.

Parameters:

id -

asComponent

IFlowComponent asComponent(Flow parent,
                         java.lang.String id)

Acquires an IFlowComponent personality.
Once acquired it cannot be changed, the same personality instance will be returned.

Parameters:

parent -

id -

getLastActiveFormName

java.lang.String getLastActiveFormName()

Returns:

The last form received by this IFlow.

getLastActiveFieldName

java.lang.String getLastActiveFieldName()

Returns:

The last field of the getLastActiveFormName() received by this IFlow.

getFocusCandidateName

java.lang.String getFocusCandidateName()

see FlowContext.flowRequiresFocus(String).

Returns:

The element (in the last active form, see getLastActiveFormName()) to which the system has to try to give the focus.