com.sapportals.wcm.rendering.screenflow.os
Class OneStepScreenflow

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.screenflow_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.rendering.screenflow.AbstractScreenflow
        |
        +--com.sapportals.wcm.rendering.screenflow.os.OneStepScreenflow

All Implemented Interfaces:

IScreenflow

public final class OneStepScreenflow

extends AbstractScreenflow

Since:

NW04, SPS4 a simple screenflow that allows an ICommand to render a OneStepComponent, to return the information entered by the user to the ICommand and let it execute its action.
That component will be rendered in its own pane, replacing the currently displayed pane. Depending on the iView-layout this might be the complete iView or just a part of it.

Inner classes inherited from class com.sapportals.wcm.rendering.screenflow.AbstractScreenflow

AbstractScreenflow.Layout

Fields inherited from class com.sapportals.wcm.rendering.screenflow.AbstractScreenflow

resBundle, STANDARD

Fields inherited from interface com.sapportals.wcm.rendering.screenflow.IScreenflow

LAYOUT_HORIZ, LAYOUT_VERTI, RENDERINGBACKEVENT, WDFBACKEVENT

Constructor Summary

OneStepScreenflow(IScreenflowData sd, java.lang.String alias, RID rid, OneStepComponent comp)

Method Summary

IRenderingEvent

execute() This method will add the needed elements to the dynamic screenflow definition.

Methods inherited from class com.sapportals.wcm.rendering.screenflow.AbstractScreenflow

addScreenflowToStartPane, createBackScreenElement, createNextScreenElement, createUniqueControlElement, createUniqueControlElement, createUniqueID, createUniquePaneElement, createUniquePaneElement, createUniquePaneElement, createUniquePaneElement, createUniquePaneElement, execute, getDynPage, getPage, getParamterValue, getScreenflowData, getStartPane, initialize, initialize, writeDebugInformation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OneStepScreenflow

public OneStepScreenflow(IScreenflowData sd,
                         java.lang.String alias,
                         RID rid,
                         OneStepComponent comp)

Parameters:

sd - this is provided to the ICommand in the execute(IScreenflowData) method.

alias - the alias of the calling command

rid - the rid of the resource the command should execute on

comp - the component that should be rendered on the new page None of the parameters must be null

Method Detail

execute

public IRenderingEvent execute()
                        throws WcmException

This method will add the needed elements to the dynamic screenflow definition. If this dynamic screenflow has been defined before, nothing is added to the definition.

Overrides:

execute in class AbstractScreenflow

Returns:

a RenderingEvent with a WdfOneStepEvent nested inside. This event will hold all parameters submitted in the constructor of this class except the IScreenflowData instance.