Package com.liferay.application.list
Interface PanelApp
- All Superinterfaces:
PanelEntry
- All Known Implementing Classes:
BaseJSPPanelApp,BasePanelApp,PortletPanelAppAdapter
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:
-
Method Summary
Modifier and TypeMethodDescriptionintgetNotificationsCount(com.liferay.portal.kernel.model.User user) Returns the number of notifications for the user.com.liferay.portal.kernel.model.PortletReturns the portlet associated with the application.Returns the portlet's ID associated with the application.javax.portlet.PortletURLgetPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest) Returns the URL used to render a portlet based on the servlet request attributes.booleaninclude(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) Returnstrueif the application successfully renders.voidsetGroupProvider(GroupProvider groupProvider) Sets theGroupProviderassociated with the application.Methods inherited from interface com.liferay.application.list.PanelEntry
getKey, getLabel, isShow
-
Method Details
-
getNotificationsCount
int getNotificationsCount(com.liferay.portal.kernel.model.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
com.liferay.portal.kernel.model.Portlet getPortlet()Returns the portlet associated with the application.- Returns:
- the portlet associated with the application
-
getPortletId
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 com.liferay.portal.kernel.exception.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:
com.liferay.portal.kernel.exception.PortalException- if a portal exception occurred
-
include
boolean include(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws IOException Returnstrueif the application successfully renders.- Parameters:
httpServletRequest- the servlet request used in the rendering processhttpServletResponse- the servlet response used in the rendering process- Returns:
trueif the application successfully renders;falseotherwise- Throws:
IOException- if an IO exception occurred
-
setGroupProvider
Sets theGroupProviderassociated with the application.- Parameters:
groupProvider- the group provider associated with the application
-