com.sapportals.admin.wizardframework.api

Interface IBasicEditingContext

All Known Subinterfaces:

IEditorContext, IWizardContext

Deprecated. Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).

public interface IBasicEditingContext

The interface that represents the basic editor/wizard context.

Method Summary

Map	getInitialParameters() Deprecated. Gets a map of the request parameters passed to the editor.
Object	getProperty(String key) Deprecated. Gets a property object specified by a key.
IPortalComponentRequest	getRequest() Deprecated. Gets the request from which the context was constructed.
com.sapportals.util.session.util.StoreableMap	getSubtreeAsMap(String subtreeRoot) Deprecated. Gets a map that represents a subtree of a property.
void	removeProperty(String key) Deprecated. Removes a property specified by a key.
void	removeSubtree(String subtreeRoot) Deprecated. Removes a property and all of its subproperties.
void	setProperty(String key, Object value) Deprecated. Sets a value for a property specified by a key.
void	setTemporaryProperty(String key, Object value) Deprecated. Sets a value for a temporary property specified by a key.

Method Detail

getInitialParameters

Map getInitialParameters()

Deprecated.

Gets a map of the request parameters passed to the editor. These parameters include: the object ID of the object being edited, the editor ID and the session ID.

Returns:

a map of parameters

setProperty

void setProperty(String key,
                 Object value)

Deprecated.

Sets a value for a property specified by a key.

Parameters:

key - a property key

value - a value for the property

getProperty

Object getProperty(String key)

Deprecated.

Gets a property object specified by a key.

Returns:

a property object

getSubtreeAsMap

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

Deprecated.

Gets a map that represents a subtree of a property.

Parameters:

subtreeRoot - a property that is the root of the subtree

Returns:

a map of the subtree

setTemporaryProperty

void setTemporaryProperty(String key,
                          Object value)

Deprecated.

Sets a value for a temporary property specified by a key. This property is available in the current request cycle only.

Parameters:

key - a property key

value - a value for the property

removeProperty

void removeProperty(String key)

Deprecated.

Removes a property specified by a key.

Parameters:

key - a property key

removeSubtree

void removeSubtree(String subtreeRoot)

Deprecated.

Removes a property and all of its subproperties.

Parameters:

subtreeRoot - a property that is the root of the subtree to remove

getRequest

IPortalComponentRequest getRequest()

Deprecated.

Gets the request from which the context was constructed.
The request must be used only for services that are not supported by the editor framework.
Note: Do not use the request for saving properties and/or any other service provided by the editor framework.

Returns:

a request object

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[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
[sap.com] EP-RUNTIME	[sap.com] com.sap.portal.admin.wizardframeworkdeprecated	api	EP-PIN-APF