com.sapportals.wcm.rendering.base

Class NavigationMemory

java.lang.Object
  com.sapportals.wcm.rendering.base.NavigationMemory

public final class NavigationMemory

extends Object

This class holds two different lists, both holding RID[] arrays, which consist of two elements - a RID and a matching startRID, which must be an ancestor or the same as the RID. It allows to add elements to these lists and to retrieve the complete lists or lists that exclude an possible entry of the given RID/ startRID combination. This class can be made available in the session of the user, allowing her to share navigation targets (the RIDs) between different iViews. Depending on the way, the entries of RID/ startRID are added, a complete navigation history can be kept in this class or just RIDs stemming from certain navigation actions or explicit user interaction. This class allows a maximum of 100 entries for each list.

Field Summary

static String

NAVIGATION_MEMORY_KEY

Constructor Summary

NavigationMemory(int size, IResourceContext context)

NavigationMemory(int size, RID startRID, IResourceContext context)

Method Summary

void	addCurrent(RID rid, RID startRID)
void	addTarget(RID rid, RID startRID)
List	getCurrents()
List	getCurrents(RID rid, RID startRID, int maxNumber)
List	getTargets()
List	getTargets(RID rid, RID startRID, int maxNumber)
void	reset()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAVIGATION_MEMORY_KEY

public static final String NAVIGATION_MEMORY_KEY

See Also:

Constant Field Values

Constructor Detail

NavigationMemory

public NavigationMemory(int size,
                        RID startRID,
                        IResourceContext context)

NavigationMemory

public NavigationMemory(int size,
                        IResourceContext context)

Method Detail

addTarget

public void addTarget(RID rid,
                      RID startRID)

addCurrent

public void addCurrent(RID rid,
                       RID startRID)

reset

public void reset()

getTargets

public List getTargets()

getCurrents

public List getCurrents()

getTargets

public List getTargets(RID rid,
                       RID startRID,
                       int maxNumber)

getCurrents

public List getCurrents(RID rid,
                        RID startRID,
                        int maxNumber)