com.sap.portal.admin.editor

Interface IEditorContext

All Superinterfaces:

IBasicEditingContext

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

public interface IEditorContext
extends IBasicEditingContext

The interface that represents the current state of the editor and the data model.
The data model holds the data currently being edited in a session. The data model is provided by the wizard framework to make it easier to handle and store the data that administrators enter into the editor. The data model is a set of key-value pairs that is available via the editor context, which is exposed as an IEditorContext parameter in key methods of the editor framework.
The following are the main services provided:

• Data Model Handling: The data model can be maintained via the set/get property methods. It is also possible to set a temporary property that is available for the current request only.
  • Statefull Editor: The data model is stored in the server session. Any object can be stored in a transparent way.
  • Stateless Editor: The data model is stored in a stateless session. The data is passed between the client and server side, so each object must be able to serialize itself to the client side. The basic Java objects and the Java collection framework are supported. Special objects that need to be stored in a stateless session must implement the IStorable interface that is located in the admin utilities PAR file.
    Note: When trying to get a collection value, always use the interface type (since the stateless session replaces the inserted collection objects with its own special version).
    Note: Temporary properties do not have to obey the stateless session rules since they are not available beyond the current request cycle.

  
                 editorContext.setProperty("prop1",new Integer(1));
  
                 List list=new ArrayList();
                 list.add("element1");
                 editorContext.setProperty("prop2",list);
  
                 editorContext.setTemporaryProperty
                         ("prop3",new MyObject());
  
                 Integer val=
                           (Integer)editorContext.getProperty("prop1");
  
                 List listVal=   
                           (List)editorContext.getProperty("prop2");
  
                 MyObject myObj=(MyObject) editorContext.getProperty("prop3");
     

• Editor Reset Trigger: When the editor needs to trigger a reset, it changes the requireLoadData flag. This flag indicates to the editor framework whether the data was already loaded from server. Usually, this flag is false when the editor is first launched. After loading the data, the flag changes to true. To reset the data, the flag is set to false. In a regular refresh event this is performed transparently by the editor framework.

  
         editorContext.setLoadDataRequired (true);
     

• Editor Parameters: The parameters passed to the editor in the URL. These parameters include the object ID, editor ID, and session ID. Although the parameters are usually available in the first request only, the editor framework stores them in the session, and they are available to the editor at any time. The object ID is available using a special method.

  
         Map parameters = (Map)   editorContext.getInitialParameters();
  
         String objId= editorContext.getObjectId();
           
  

• Read-only Handling: A state when the editor data cannot be edited. This situation occurs, for example, if the data could not be locked, or if the user does not have permission to edit the data. The editor framework is responsible for disabling the generic buttons, and enabling the Edit Mode button. The editor framework maintains a flag that indicates whether the current state is read-only. If lock handling fails, the editor context is automatically flagged as read-only.
  

  
         boolean myReadOnly = ;
         if (myReadOnly)
                 editorContext.setReadOnly();
     

• Dirty State Handling: Occurs when the data in the editor is different from the data in the persistence layer. This happens if the user edits the data presented in the editor, or raises an event that causes data to change. A dirty state must trigger the Save button to be enabled, and the editor must ask the user whether to save the data before closing the editor. The editor context has a flag to indicate a dirty state that must be maintained by the editor.

  
        editorContext.setDirty(true);
           

  
  Note: This flag is maintained on the client side and is synchronized with the server side.
• Editor Response: A set of methods that handle operations related to the client side.
• Question Before Save: When the user clicks the Save button, the default behavior is to perform a save operation. However, it is possible to add a question to present to the user, asking whether to perform a save.
  For example: Are you sure that you want to save? [yes | no])

  
         editorContext.getEditorResponse().
         setBeforeSaveQuestion();
     

• End-user Messages: During the request it is possible to add a message that is presented to the end-user. The message can use different levels of severity such as error, warning or info. The severities are enumerated using the EditorMessageType class. The editor framework collects the messages and presents them ordered by severity. NLS formatting is performed just before sending the response to the client.

         context.getEditorResponse().addMessageKey
         (EditorMessageType.ERROR,
         "MSG_X_KEY",
         new Object[] {"param1"});
     

• Client Properties: In some cases, while processing an event on the server side, or during user interface preparation, there is a need to get properties that will be available later on the client side. This functionality is given by the editor response. The IEditorResponse interface is used to retrieve the properties from the client side.

                 editorContext.getEditorResponse().setClientProperty
                                    ("key","data");
    

Method Summary

IEditorResponse	getEditorResponse() Deprecated. Gets the editor response object for the current context.
com.sapportals.htmlb.event.Event	getEvent() Deprecated. Gets the event object that was sent by an HTMLB control.
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 an object that represents a subtree of properties.
boolean	isDirty() Deprecated. Indicates whether the editor state was changed and a save is required when the editor is closed.
boolean	isEmbeddedEditor() Deprecated. Indicates whether an editor was opened as an embedded editor.
boolean	isHoldLock() Deprecated. Indicates whether the current context holds a lock.
boolean	isReadOnly() Deprecated. Indicates whether the editor is read-only.
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	setDirty(boolean isDirty) Deprecated. Sets whether the editor state changed.
void	setLoadDataRequired(boolean requireLoadData) Deprecated. Sets whether the editor data must be loaded.
void	setProperty(String key, Object value) Deprecated. Sets a value for a property specified by a key.
void	setReadOnly() Deprecated. Sets the editor context as read-only.
void	setTemporaryProperty(String key, Object value) Deprecated. Sets a temporary property specified by a key.

Method Detail

setLoadDataRequired

void setLoadDataRequired(boolean requireLoadData)

Deprecated.

Sets whether the editor data must be loaded. This method is used to reset the data. If set to true, the editor loads the data from the server in the next request cycle.

Parameters:

requireLoadData - true if the data must be loaded, false if the data should not be loaded

setDirty

void setDirty(boolean isDirty)

Deprecated.

Sets whether the editor state changed. If the editor state changed, a save operation is required when the editor is closed.
The default value is false. When set to true, the data persists until saving.
After a save operation, the value is reset.

Parameters:

isDirty - true if a save is required, false if no save is required

isDirty

boolean isDirty()

Deprecated.

Indicates whether the editor state was changed and a save is required when the editor is closed. The default value is false. When true, the data persists until saving.
After a save operation, the value is reset.

Returns:

true if a save is required, false if no save is required

getInitialParameters

Map getInitialParameters()

Deprecated.

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

Specified by:

getInitialParameters in interface IBasicEditingContext

Returns:

a map of parameters

getEditorResponse

IEditorResponse getEditorResponse()

Deprecated.

Gets the editor response object for the current context.

Returns:

an editor response object

See Also:

IEditorResponse

isEmbeddedEditor

boolean isEmbeddedEditor()

Deprecated.

Indicates whether an editor was opened as an embedded editor.
The default value is false. The value is set to true when the main editor passes the following parameter in the request: com.sap.portal.editorMode=embedded

Returns:

true if the editor is an embedded editor, false if not

getEvent

com.sapportals.htmlb.event.Event getEvent()

Deprecated.

Gets the event object that was sent by an HTMLB control.

Returns:

an HTMLB event

isHoldLock

boolean isHoldLock()

Deprecated.

Indicates whether the current context holds a lock. Can be used to indicate that a lock release is required.

Returns:

true if the current context holds the lock, false if not

setProperty

void setProperty(String key,
                 Object value)

Deprecated.

Sets a value for a property specified by a key.

Specified by:

setProperty in interface IBasicEditingContext

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.

Specified by:

getProperty in interface IBasicEditingContext

Returns:

the property object

setReadOnly

void setReadOnly()

Deprecated.

Sets the editor context as read-only. Read-only mode is valid for the current request only. Once the editor context is set as read-only, the mode cannot be changed for the current request.

isReadOnly

boolean isReadOnly()

Deprecated.

Indicates whether the editor is read-only.

Returns:

true if read-only, false if read-write

getSubtreeAsMap

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

Deprecated.

Gets an object that represents a subtree of properties.

Specified by:

getSubtreeAsMap in interface IBasicEditingContext

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 temporary property specified by a key. This property is available in the current request cycle only.

Specified by:

setTemporaryProperty in interface IBasicEditingContext

Parameters:

key - a property key

value - a value for the property

removeProperty

void removeProperty(String key)

Deprecated.

Removes a property specified by a key.

Specified by:

removeProperty in interface IBasicEditingContext

Parameters:

key - a property key

removeSubtree

void removeSubtree(String subtreeRoot)

Deprecated.

Removes a property and all of its subproperties.

Specified by:

removeSubtree in interface IBasicEditingContext

Parameters:

subtreeRoot - the 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.

Specified by:

getRequest in interface IBasicEditingContext

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