NavigationalStateContext - JBOSS Portal 2.2 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.server.navigation
Class NavigationalStateContext

java.lang.Object
  org.jboss.portal.server.navigation.NavigationalStateContext

public class NavigationalStateContext
extends java.lang.Object

The per request nagivational state context.

Method Summary

static NavigationalState getNavigationalState(java.lang.String id)
          Provide the navigational state for an id.

static NavigationalStateProvider getProvider()
          Return the provider associated with the current thread of execution.

static void setProvider(NavigationalStateProvider provider)
          Set the provider on the current thread of execution.

Methods inherited from class java.lang.Object

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

Method Detail

getNavigationalState

public static NavigationalState getNavigationalState(java.lang.String id)
                                              throws java.lang.IllegalStateException

Provide the navigational state for an id.

Parameters:: id - the id of the object we want the state
Returns:: the corresponding navigational state
Throws:: java.lang.IllegalStateException - if the current thread of execution is associated with no provider

getProvider

public static NavigationalStateProvider getProvider()

Return the provider associated with the current thread of execution.

setProvider

public static void setProvider(NavigationalStateProvider provider)

Set the provider on the current thread of execution.