com.liferay.portal.service
Interface PortletLocalService


public interface PortletLocalService

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This interface defines the service. The default implementation is com.liferay.portal.service.impl.PortletLocalServiceImpl. Modify methods in that class and rerun ServiceBuilder to populate this class and all other generated classes.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:
Brian Wing Shun Chan
See Also:
PortletLocalServiceFactory, PortletLocalServiceUtil

Method Summary
 Portlet addPortlet(Portlet portlet)
           
 void deletePortlet(long id)
           
 void deletePortlet(Portlet portlet)
           
 void destroyPortlet(Portlet portlet)
           
 java.util.List<Portlet> dynamicQuery(com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
           
 java.util.List<Portlet> dynamicQuery(com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer, int begin, int end)
           
 PortletCategory getEARDisplay(java.lang.String xml)
           
 java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers()
           
 Portlet getPortletById(long companyId, java.lang.String portletId)
           
 Portlet getPortletByStrutsPath(long companyId, java.lang.String strutsPath)
           
 java.util.List<Portlet> getPortlets()
           
 java.util.List<Portlet> getPortlets(long companyId)
           
 java.util.List<Portlet> getPortlets(long companyId, boolean showSystem, boolean showPortal)
           
 PortletCategory getWARDisplay(java.lang.String servletContextName, java.lang.String xml)
           
 boolean hasPortlet(long companyId, java.lang.String portletId)
           
 void initEAR(java.lang.String[] xmls, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
           
 java.util.List<Portlet> initWAR(java.lang.String servletContextName, java.lang.String[] xmls, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
           
 Portlet updatePortlet(long companyId, java.lang.String portletId, java.lang.String roles, boolean active)
           
 Portlet updatePortlet(Portlet portlet)
           
 

Method Detail

addPortlet

Portlet addPortlet(Portlet portlet)
                   throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

deletePortlet

void deletePortlet(long id)
                   throws com.liferay.portal.SystemException,
                          com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deletePortlet

void deletePortlet(Portlet portlet)
                   throws com.liferay.portal.SystemException,
                          com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

dynamicQuery

java.util.List<Portlet> dynamicQuery(com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
                                     throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

dynamicQuery

java.util.List<Portlet> dynamicQuery(com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
                                     int begin,
                                     int end)
                                     throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

updatePortlet

Portlet updatePortlet(Portlet portlet)
                      throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

destroyPortlet

void destroyPortlet(Portlet portlet)

getEARDisplay

PortletCategory getEARDisplay(java.lang.String xml)
                              throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getWARDisplay

PortletCategory getWARDisplay(java.lang.String servletContextName,
                              java.lang.String xml)
                              throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getFriendlyURLMappers

java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers()

getPortletById

Portlet getPortletById(long companyId,
                       java.lang.String portletId)
                       throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getPortletByStrutsPath

Portlet getPortletByStrutsPath(long companyId,
                               java.lang.String strutsPath)
                               throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getPortlets

java.util.List<Portlet> getPortlets()

getPortlets

java.util.List<Portlet> getPortlets(long companyId)
                                    throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

getPortlets

java.util.List<Portlet> getPortlets(long companyId,
                                    boolean showSystem,
                                    boolean showPortal)
                                    throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

hasPortlet

boolean hasPortlet(long companyId,
                   java.lang.String portletId)
                   throws com.liferay.portal.SystemException
Throws:
com.liferay.portal.SystemException

initEAR

void initEAR(java.lang.String[] xmls,
             com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)

initWAR

java.util.List<Portlet> initWAR(java.lang.String servletContextName,
                                java.lang.String[] xmls,
                                com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)

updatePortlet

Portlet updatePortlet(long companyId,
                      java.lang.String portletId,
                      java.lang.String roles,
                      boolean active)
                      throws com.liferay.portal.SystemException,
                             com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException