com.liferay.application.list

Interface PanelApp

All Superinterfaces:

PanelEntry

All Known Implementing Classes:

BaseJSPPanelApp, BasePanelApp, PortletPanelAppAdapter

public interface PanelApp
extends PanelEntry

Provides an interface that defines applications to be used by a liferay-application-list:panel-app tag instance to render a new panel application. Applications are included within application categories defined by PanelCategory implementations.

See Also:

PanelEntry

Method Summary

Modifier and Type	Method and Description
int	getNotificationsCount(User user) Returns the number of notifications for the user.
Portlet	getPortlet() Returns the portlet associated with the application.
java.lang.String	getPortletId() Returns the portlet's ID associated with the application.
javax.portlet.PortletURL	getPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest) Returns the URL used to render a portlet based on the servlet request attributes.
boolean	include(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) Returns true if the application successfully renders.
void	setGroupProvider(GroupProvider groupProvider) Sets the GroupProvider associated with the application.
void	setPortlet(Portlet portlet) Sets the portlet associated with the application.

Methods inherited from interface com.liferay.application.list.PanelEntry

getKey, getLabel, isShow

Method Detail

getNotificationsCount

int getNotificationsCount(User user)

Returns the number of notifications for the user.

Parameters:

user - the user from which notifications are retrieved

Returns:

the number of notifications for the user

getPortlet

Portlet getPortlet()

Returns the portlet associated with the application.

Returns:

the portlet associated with the application

getPortletId

java.lang.String getPortletId()

Returns the portlet's ID associated with the application.

Returns:

the portlet's ID associated with the application

getPortletURL

javax.portlet.PortletURL getPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest)
                                throws PortalException

Returns the URL used to render a portlet based on the servlet request attributes.

Parameters:

httpServletRequest - the servlet request used to create a portlet's URL

Returns:

the portlet's URL used to render a target portlet

Throws:

PortalException - if a portal exception occurred

include

boolean include(javax.servlet.http.HttpServletRequest httpServletRequest,
                javax.servlet.http.HttpServletResponse httpServletResponse)
         throws java.io.IOException

Returns true if the application successfully renders.

Parameters:

httpServletRequest - the servlet request used in the rendering process

httpServletResponse - the servlet response used in the rendering process

Returns:

true if the application successfully renders; false otherwise

Throws:

java.io.IOException - if an IO exception occurred

setGroupProvider

void setGroupProvider(GroupProvider groupProvider)

Sets the GroupProvider associated with the application.

Parameters:

groupProvider - the group provider associated with the application

setPortlet

void setPortlet(Portlet portlet)

Sets the portlet associated with the application.

Parameters:

portlet - the portlet associated with the application