com.ibm.portal.model
Interface NavigationModelProvider

public interface NavigationModelProvider

An interface for a provider of navigation models. Context ctx = new InitialContext();
NavigationModelHome home = (NavigationModelHome) ctx.lookup(NavigationModelHome.JNDI_NAME);
if (home != null) {
NavigationModel model = home.getNavigationModelProvider().getNavigationModel(aRequest, aResponse);
...
}


Since:

5.1.0.1

Field Summary

static java.lang.String

JNDI_NAME

Method Summary

<T extends java.lang.Object & NavigationNode> NavigationModel<T>

getNavigationModel(javax.servlet.ServletRequest aRequest, javax.servlet.ServletResponse aResponse) Returns the navigation model applicable in the current request.

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME

Since:

6.1.0.1

See Also:

Constant Field Values

Method Detail

getNavigationModel

<T extends java.lang.Object & NavigationNode> NavigationModel<T> getNavigationModel(javax.servlet.ServletRequest aRequest,
                                                                                   javax.servlet.ServletResponse aResponse)
                                                                               throws ModelException

Returns the navigation model applicable in the current request.

Parameters:

aRequest - the current request

aResponse - the current response

Returns:

the navigation model valid in the current request

Throws:

ModelException - in case the model cannot be obtained