SAP NetWeaver '04

com.sapportals.wcm.rendering.base
Class NavigationMemorizer

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.base_api.jar]
com.sapportals.wcm.rendering.base.NavigationMemorizer
All Implemented Interfaces:
INavigationMemorizer

public final class NavigationMemorizer
implements INavigationMemorizer

acts as a layer between each instance of a NavigationMemory and the ICache that acts as persistence layer to keep the navigation memory across http-requests. For each IUser, there will be only one entry in this memorizer. Entries will be deleted over time. See the ICache for details. This class is implemented as a singleton. The method getId of the class IUser should be used to add, modify and delete entries within this class.

Since:
EP6, SP1

Method Summary
 boolean addMemory(NavigationMemory memory, java.lang.String key, boolean overwrite)
           
 void configEvent(com.sapportals.config.event.ConfigEvent arg0)
           
 java.lang.String getConfigListenerId()
           
static NavigationMemorizer getInstance()
           
 NavigationMemory getMemory(java.lang.String key)
          returns the NavigationMemory instance that has been added with the given key via this class' addMemory method.
 IRidList getRecent(IResource resource)
          Gets session navigation information for a user
 boolean isExcluded(RID rid)
           
 boolean removeMemory(java.lang.String key)
           
 

Method Detail

isExcluded

public boolean isExcluded(RID rid)

getInstance

public static NavigationMemorizer getInstance()

getMemory

public NavigationMemory getMemory(java.lang.String key)
returns the NavigationMemory instance that has been added with the given key via this class' addMemory method. If the NavigationMemorizer has not been initialized properly or no entry is available for the given key, the method will return null.
Parameters:
key - the key that has been used to add the requested object via this class' addMemory method. Must not be null.
Returns:
the mapped NavigationMemory for the given key or null.

addMemory

public boolean addMemory(NavigationMemory memory,
                         java.lang.String key,
                         boolean overwrite)

removeMemory

public boolean removeMemory(java.lang.String key)

getRecent

public IRidList getRecent(IResource resource)
Description copied from interface: INavigationMemorizer
Gets session navigation information for a user
Specified by:
getRecent in interface INavigationMemorizer
Following copied from interface: com.sapportals.wcm.repository.manager.entrypoints.recent.INavigationMemorizer
Parameters:
resource - current resource
Returns:
resource IDs that are stored as navigation information

getConfigListenerId

public java.lang.String getConfigListenerId()

configEvent

public void configEvent(com.sapportals.config.event.ConfigEvent arg0)

SAP NetWeaver '04

Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.