com.sap.portal.admin.editor

Interface IEditorResponse

Deprecated.

As of SAP NetWeaver 2007 release, replaced by package com.sap.portal.adminstudio.workunitfwapi

public interface IEditorResponse

The interface that represents the editor response. The interface provides access to the portal response object, as well as additional functionality for the editor framework.
This interface can be used for any response type.

Method Summary

Modifier and Type	Method and Description
void	addJavaScript(String javaScript) Deprecated. Adds JavaScript code to the response.
void	addMessageKey(EditorMessageType messageType, String messageKey) Deprecated. Adds a message key that represents a message displayed to the user.
void	addMessageKey(EditorMessageType messageType, String messageKey, Object[] parameters) Deprecated. Adds a message key that represents a formatted message displayed to the user.
IPortalComponentResponse	getResponse() Deprecated. Gets the portal component response.
void	include(INode node) Deprecated. Includes a POM node on this response.
void	setBeforeSaveQuestion(String question) Deprecated. Generates a question that is displayed when the user saves editor content.
void	setClientProperty(String key, String data) Deprecated. Associates the specified property data with a key.

Method Detail

include

void include(INode node)

Deprecated.

Includes a POM node on this response. The POM node represents a component involved in generating the HTML content for the HTTP request.

Parameters:

node - the POM node to include

setBeforeSaveQuestion

void setBeforeSaveQuestion(String question)

Deprecated.

Generates a question that is displayed when the user saves editor content.

Parameters:

question - the question string in NLS format

setClientProperty

void setClientProperty(String key,
                       String data)

Deprecated.

Associates the specified property data with a key. The data is available on the client side, and can be retrieved using parametersMap.get([key]).

Parameters:

key - a key

data - data to associate with the key

getResponse

IPortalComponentResponse getResponse()

Deprecated.

Gets the portal component response. Use only for services that demand a response.

Returns:

a response

addJavaScript

void addJavaScript(String javaScript)

Deprecated.

Adds JavaScript code to the response.

Parameters:

javaScript - JavaScript code

addMessageKey

void addMessageKey(EditorMessageType messageType,
                   String messageKey)

Deprecated.

Adds a message key that represents a message displayed to the user.

Parameters:

messageType - a message type

messageKey - a message key

addMessageKey

void addMessageKey(EditorMessageType messageType,
                   String messageKey,
                   Object[] parameters)

Deprecated.

Adds a message key that represents a formatted message displayed to the user. The message is formatted using the specified parameters.
The parameters contain the strings to be inserted dynamically into your message. The objects in this parameter array, replace placeholders. Each placeholder is a number in braces and the number represents the offset in the array.
For example if you have the message “The object is locked by user: {0}� the parameters array contains the name of the user to be inserted at runtime to the message instead of the {0} sign.

Parameters:

messageType - a message type

messageKey - a message key

parameters - an array of parameters used for formatting the message