Package org.exoplatform.portal.mop.navigation

Class NavigationContext

java.lang.Object

org.exoplatform.portal.mop.navigation.NavigationContext

public class NavigationContext
extends Object

Version:

$Revision$

Author:

Julien Viet

Constructor Summary

Constructors

Constructor	Description
NavigationContext(NavigationData data)
NavigationContext(SiteKey key, NavigationState state)

Method Summary

Modifier and Type	Method	Description
NavigationData	getData()
SiteKey	getKey()	Returns the navigation key.
NavigationState	getState()	Returns the navigation state.
void	setData(NavigationData data)
void	setState(NavigationState state)	Updates the navigation state the behavior is not the same wether or not the navigation is persistent: When the navigation is persistent, any state is allowed: A non null state overrides the current persistent state. The null state means to reset the state to the persistent state. When the navigation is transient, only a non null state is allowed as it will be used for creation purpose.

Methods inherited from class java.lang.Object

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

Constructor Details

NavigationContext

public NavigationContext(NavigationData data)

NavigationContext

public NavigationContext(SiteKey key,
 NavigationState state)

Method Details

getKey

public SiteKey getKey()

Returns the navigation key.

Returns:

the navigation key

getState

public NavigationState getState()

Returns the navigation state.

Returns:

the navigation state

getData

public NavigationData getData()

setData

public void setData(NavigationData data)

setState

public void setState(NavigationState state)
              throws IllegalStateException

Updates the navigation state the behavior is not the same wether or not the navigation is persistent: When the navigation is persistent, any state is allowed:

• A non null state overrides the current persistent state.
• The null state means to reset the state to the persistent state.
• When the navigation is transient, only a non null state is allowed as it will be used for creation purpose.

Parameters:

state - the new state

Throws:

IllegalStateException - when the state is cleared and the navigation is not persistent