Package org.exoplatform.portal.mop.page

Class PageContext

java.lang.Object
org.exoplatform.portal.mop.page.PageContext
public class PageContext extends Object
Author:
Julien Viet

  • Constructor Summary

    Constructors
    Constructor
    Description
    PageContext(PageKey key, PageState state)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    PageKey
    getKey()
    Returns the navigation key.
    PageState
    getState()
    Returns the navigation state.
    void
    setState(PageState state)
    Updates the page state the behavior is not the same wether or not the page is persistent: When the page 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 page is transient, only a non null state is allowed as it will be used for creation purpose.
    void
    update(Page page)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • getKey

      public PageKey getKey()
      Returns the navigation key.
      Returns:
      the navigation key

    • getState

      public PageState getState()
      Returns the navigation state.
      Returns:
      the navigation state

    • setState

      public void setState(PageState state) throws IllegalStateException
      Updates the page state the behavior is not the same wether or not the page is persistent: When the page 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 page 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

    • update

      public void update(Page page) throws NullPointerException
      Throws:
      NullPointerException