com.sapportals.admin.wizardframework.api

Interface IWizardContext

All Superinterfaces:

IBasicEditingContext

public interface IWizardContext
extends IBasicEditingContext

The interface that represents the current state of the wizard. It wraps the user request and response, the session data model and the initial parameters that are passed to the wizard.
It also provides access to the state machine of this instance and the dependency handler.

Field Summary

static String

WIZARD_INSTANCE A constant that indicates a wizard instance.

Method Summary

void	changeWizardTitle(String newTitle) Sets the wizard title.
IWizardComponent	getComponent(String key) Gets the wizard component specified by a key.
ClassLoader	getContextClassLoader() Gets the class loader for this context.
String	getEvent() Gets the current event sent by the component.
com.sapportals.htmlb.rendering.IPageContext	getPageContext() Gets the page context for the request.
Object	getProperty(String key) Gets the property specified by a key.
WizardSession	getSession() Gets the session for the wizard instance.
com.sapportals.util.session.util.StoreableMap	getSubtreeAsMap(String subtreeRoot) Gets an object that represents a subtree of a property.
Map	getWizardParameters() Gets the wizard parameters.
IWizardStructure	getWizardStructure() Gets the static structure of a wizard pane.
void	log(String msg) Sets a log message.
void	objectChanged(String changedObjectKey) Calls the dependency handler after an object is changed.
void	overrideStateMachine(String paneKey) Forces the next pane executed to be the specified pane.
void	removeProperty(String key) Removes the property specified by a key from the session.
void	removeSubtree(String subtreeRoot) Removes the property specified by a key and all its subproperties from the session.
void	setProperty(String key, Object value) Sets the property value specified by a key.
void	setTemporaryProperty(String key, Object value) Sets a property value specified by a key that is valid for the current request only.
void	severe(Throwable t, String msg) Sets a severe message.
void	warning(String msg) Sets a warning message.

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

getInitialParameters, getRequest

Field Detail

WIZARD_INSTANCE

static final String WIZARD_INSTANCE

A constant that indicates a wizard instance.
wizard

See Also:

Constant Field Values

Method Detail

getContextClassLoader

ClassLoader getContextClassLoader()

Gets the class loader for this context.

Returns:

the class loader

getWizardStructure

IWizardStructure getWizardStructure()

Gets the static structure of a wizard pane.

Returns:

the wizard structure

getSession

WizardSession getSession()

Gets the session for the wizard instance.

Returns:

the wizard session

getPageContext

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

Gets the page context for the request.

Returns:

the page context

objectChanged

void objectChanged(String changedObjectKey)

Calls the dependency handler after an object is changed.

Parameters:

changedObjectKey - an object key

overrideStateMachine

void overrideStateMachine(String paneKey)

Forces the next pane executed to be the specified pane.

Parameters:

paneKey - a pane key

setProperty

void setProperty(String key,
                 Object value)

Sets the property value specified by a key.

Specified by:

setProperty in interface IBasicEditingContext

Parameters:

key - a key

value - a value

setTemporaryProperty

void setTemporaryProperty(String key,
                          Object value)

Sets a property value specified by a key that is valid for the current request only.

Specified by:

setTemporaryProperty in interface IBasicEditingContext

Parameters:

key - a key

value - a value

getProperty

Object getProperty(String key)

Gets the property specified by a key.

Specified by:

getProperty in interface IBasicEditingContext

Parameters:

key - a key

Returns:

a property object

removeProperty

void removeProperty(String key)

Removes the property specified by a key from the session.

Specified by:

removeProperty in interface IBasicEditingContext

Parameters:

key - a key

removeSubtree

void removeSubtree(String subtreeRoot)

Removes the property specified by a key and all its subproperties from the session.

Specified by:

removeSubtree in interface IBasicEditingContext

Parameters:

subtreeRoot - a root for the property to remove

getSubtreeAsMap

com.sapportals.util.session.util.StoreableMap getSubtreeAsMap(String subtreeRoot)

Gets an object that represents a subtree of a property.

Specified by:

getSubtreeAsMap in interface IBasicEditingContext

Parameters:

subtreeRoot - a property that is the root of the subtree

Returns:

a map of the subtree

getComponent

IWizardComponent getComponent(String key)

Gets the wizard component specified by a key.

Parameters:

key - a key

Returns:

the wizard component

getEvent

String getEvent()

Gets the current event sent by the component.

Returns:

the event

changeWizardTitle

void changeWizardTitle(String newTitle)

Sets the wizard title. The title is displayed in the upper frame of the wizard window.

Parameters:

newTitle - a wizard title

getWizardParameters

Map getWizardParameters()

Gets the wizard parameters.

Returns:

a map of parameters

log

void log(String msg)

Sets a log message.

Parameters:

msg - a message

warning

void warning(String msg)

Sets a warning message.

Parameters:

msg - a message

severe

void severe(Throwable t,
            String msg)

Sets a severe message.

Parameters:

t - an exception

msg - a message

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] com.sap.portal.admin.wizardframeworkdeprecated	api	EP-PIN-APF
[sap.com] EP-RUNTIME	[sap.com] tc/ep/admin/api	api	EP-PIN
[sap.com] EP-RUNTIME	[sap.com] com.sap.portal.admin.wizardframeworkdeprecated	-	EP-PIN-APF