com.ibm.portal.portlet.service.model
Interface NavigationModelProvider

All Superinterfaces:

PortletService

public interface NavigationModelProvider
extends PortletService

An interface for a provider of navigation models.

PortletServiceHome psh;
javax.naming.Context ctx = new javax.naming.InitialContext();
boolean serviceAvailable = false;

try {
psh = (PortletServiceHome) ctx.lookup("portletservice/com.ibm.portal.portlet.service.model.NavigationModelProvider");
serviceAvailable = true;
} catch(javax.naming.NameNotFoundException ex) {
... error handling ...
}
...
if (serviceAvailable) {
NavigationModelProvider provider = (NavigationModelProvider) psh.getPortletService(NavigationModelProvider.class);
NavigationModel model = provider.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.portlet.PortletRequest aRequest, javax.portlet.PortletResponse 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.portlet.PortletRequest aRequest,
                                                                                   javax.portlet.PortletResponse 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