com.sapportals.admin.wizardframework.api
Interface IWizardContext

All Superinterfaces:

IBasicEditingContext

public interface IWizardContext

extends IBasicEditingContext

WizardContext combines all the sources of information a wizard component has access to at runtime. It contains the static structure of the panes, the session and the page contect, i.e. the request and the response. It also provides access to the statemachine of this instance and the dependency handler.

Version:

6.0

Field Summary

static java.lang.String

WIZARD_INSTANCE

Method Summary

void	changeWizardTitle(java.lang.String newTitle)
IWizardComponent	getComponent(java.lang.String key) get the WizardComponent at path "key" from the (static) structure of this wizard.
java.lang.ClassLoader	getContextClassLoader()
java.lang.String	getEvent() get the current event from the page context
com.sapportals.htmlb.rendering.IPageContext	getPageContext() get the page context for this request
java.lang.Object	getProperty(java.lang.String key) get the property at path "key" from the session
WizardSession	getSession() Get the session of this wizard instance.
com.sapportals.util.session.util.StoreableMap	getSubtreeAsMap(java.lang.String subtreeRoot)
java.util.Map	getWizardParameters()
IWizardStructure	getWizardStructure() Get the (static) structure of the wizard's panes.
void	log(java.lang.String msg)
void	objectChanged(java.lang.String changedObjectKey) invoke the dependency handler after an objerct was changed.
void	overrideStateMachine(java.lang.String paneKey) force the next pane executed to be the pane under key .
void	removeProperty(java.lang.String key) remove the property at path "key" from the session
void	removeSubtree(java.lang.String subtreeRoot) remove the property at path "key" and all of it's subproperties at path "key.*" from the session
void	setProperty(java.lang.String key, java.lang.Object value) set the property at path "key" in the session
void	setTemporaryProperty(java.lang.String key, java.lang.Object value) set a property that is valid only for the current request
void	severe(java.lang.Throwable t, java.lang.String msg)
void	warning(java.lang.String msg)

Methods inherited from interface com.sapportals.admin.wizardframework.api.IBasicEditingContext

getInitialParameters, getRequest

Field Detail

WIZARD_INSTANCE

public static final java.lang.String WIZARD_INSTANCE

Method Detail

getContextClassLoader

public java.lang.ClassLoader getContextClassLoader()

getWizardStructure

public IWizardStructure getWizardStructure()

Get the (static) structure of the wizard's panes.

getSession

public WizardSession getSession()

Get the session of this wizard instance.

getPageContext

public com.sapportals.htmlb.rendering.IPageContext getPageContext()

get the page context for this request

objectChanged

public void objectChanged(java.lang.String changedObjectKey)

invoke the dependency handler after an objerct was changed.

overrideStateMachine

public void overrideStateMachine(java.lang.String paneKey)

force the next pane executed to be the pane under key .

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

set the property at path "key" in the session

Specified by:

setProperty in interface IBasicEditingContext

setTemporaryProperty

public void setTemporaryProperty(java.lang.String key,
                                 java.lang.Object value)

set a property that is valid only for the current request

Specified by:

setTemporaryProperty in interface IBasicEditingContext

getProperty

public java.lang.Object getProperty(java.lang.String key)

get the property at path "key" from the session

Specified by:

getProperty in interface IBasicEditingContext

removeProperty

public void removeProperty(java.lang.String key)

remove the property at path "key" from the session

Specified by:

removeProperty in interface IBasicEditingContext

removeSubtree

public void removeSubtree(java.lang.String subtreeRoot)

remove the property at path "key" and all of it's subproperties at path "key.*" from the session

Specified by:

removeSubtree in interface IBasicEditingContext

getSubtreeAsMap

public com.sapportals.util.session.util.StoreableMap getSubtreeAsMap(java.lang.String subtreeRoot)

Specified by:

getSubtreeAsMap in interface IBasicEditingContext

getComponent

public IWizardComponent getComponent(java.lang.String key)

get the WizardComponent at path "key" from the (static) structure of this wizard.

getEvent

public java.lang.String getEvent()

get the current event from the page context

changeWizardTitle

public void changeWizardTitle(java.lang.String newTitle)

getWizardParameters

public java.util.Map getWizardParameters()

log

public void log(java.lang.String msg)

warning

public void warning(java.lang.String msg)

severe

public void severe(java.lang.Throwable t,
                   java.lang.String msg)