com.liferay.portal.service
Interface PortletLocalService

All Known Implementing Classes:
PortletLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
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:
PortletLocalServiceUtil
Generated:

Method Summary
 Portlet addPortlet(Portlet portlet)
           
 void checkPortlet(Portlet portlet)
           
 void checkPortlets(long companyId)
           
 void clearCache()
           
 Portlet clonePortlet(long companyId, java.lang.String portletId)
           
 Portlet createPortlet(long id)
           
 void deletePortlet(long id)
           
 void deletePortlet(Portlet portlet)
           
 Portlet deployRemotePortlet(Portlet portlet, java.lang.String categoryName)
           
 void destroyPortlet(Portlet portlet)
           
 void destroyRemotePortlet(Portlet portlet)
           
 java.util.List dynamicQuery(DynamicQuery dynamicQuery)
           
 java.util.List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
           
 java.util.List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
           
 long dynamicQueryCount(DynamicQuery dynamicQuery)
           
 java.util.List<CustomAttributesDisplay> getCustomAttributesDisplays()
           
 PortletCategory getEARDisplay(java.lang.String xml)
           
 java.util.List<Portlet> getFriendlyURLMapperPortlets()
           
 java.util.List<FriendlyURLMapper> getFriendlyURLMappers()
           
 Portlet getPortlet(long id)
           
 PortletApp getPortletApp(java.lang.String servletContextName)
           
 Portlet getPortletById(long companyId, java.lang.String portletId)
           
 Portlet getPortletById(java.lang.String portletId)
           
 Portlet getPortletByStrutsPath(long companyId, java.lang.String strutsPath)
           
 java.util.List<Portlet> getPortlets()
           
 java.util.List<Portlet> getPortlets(int start, int end)
           
 java.util.List<Portlet> getPortlets(long companyId)
           
 java.util.List<Portlet> getPortlets(long companyId, boolean showSystem, boolean showPortal)
           
 int getPortletsCount()
           
 PortletCategory getWARDisplay(java.lang.String servletContextName, java.lang.String xml)
           
 boolean hasPortlet(long companyId, java.lang.String portletId)
           
 void initEAR(javax.servlet.ServletContext servletContext, java.lang.String[] xmls, PluginPackage pluginPackage)
           
 java.util.List<Portlet> initWAR(java.lang.String servletContextName, javax.servlet.ServletContext servletContext, java.lang.String[] xmls, PluginPackage pluginPackage)
           
 Portlet updatePortlet(long companyId, java.lang.String portletId, java.lang.String roles, boolean active)
           
 Portlet updatePortlet(Portlet portlet)
           
 Portlet updatePortlet(Portlet portlet, boolean merge)
           
 

Method Detail

addPortlet

Portlet addPortlet(Portlet portlet)
                   throws SystemException
Throws:
SystemException

createPortlet

Portlet createPortlet(long id)

deletePortlet

void deletePortlet(long id)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

deletePortlet

void deletePortlet(Portlet portlet)
                   throws SystemException
Throws:
SystemException

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                            throws SystemException
Throws:
SystemException

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                            int start,
                            int end)
                            throws SystemException
Throws:
SystemException

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                            int start,
                            int end,
                            OrderByComparator orderByComparator)
                            throws SystemException
Throws:
SystemException

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Throws:
SystemException

getPortlet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet getPortlet(long id)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

getPortlets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Portlet> getPortlets(int start,
                                                                             int end)
                                    throws SystemException
Throws:
SystemException

getPortletsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPortletsCount()
                     throws SystemException
Throws:
SystemException

updatePortlet

Portlet updatePortlet(Portlet portlet)
                      throws SystemException
Throws:
SystemException

updatePortlet

Portlet updatePortlet(Portlet portlet,
                      boolean merge)
                      throws SystemException
Throws:
SystemException

checkPortlet

void checkPortlet(Portlet portlet)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

checkPortlets

void checkPortlets(long companyId)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

clearCache

void clearCache()

clonePortlet

Portlet clonePortlet(long companyId,
                     java.lang.String portletId)
                     throws SystemException
Throws:
SystemException

deployRemotePortlet

Portlet deployRemotePortlet(Portlet portlet,
                            java.lang.String categoryName)
                            throws SystemException
Throws:
SystemException

destroyPortlet

void destroyPortlet(Portlet portlet)

destroyRemotePortlet

void destroyRemotePortlet(Portlet portlet)

getCustomAttributesDisplays

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CustomAttributesDisplay> getCustomAttributesDisplays()

getEARDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletCategory getEARDisplay(java.lang.String xml)
                              throws SystemException
Throws:
SystemException

getFriendlyURLMapperPortlets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Portlet> getFriendlyURLMapperPortlets()

getFriendlyURLMappers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<FriendlyURLMapper> getFriendlyURLMappers()

getPortletApp

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletApp getPortletApp(java.lang.String servletContextName)

getPortletById

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet getPortletById(long companyId,
                                                                java.lang.String portletId)
                       throws SystemException
Throws:
SystemException

getPortletById

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet getPortletById(java.lang.String portletId)

getPortletByStrutsPath

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet getPortletByStrutsPath(long companyId,
                                                                        java.lang.String strutsPath)
                               throws SystemException
Throws:
SystemException

getPortlets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Portlet> getPortlets()

getPortlets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Portlet> getPortlets(long companyId)
                                    throws SystemException
Throws:
SystemException

getPortlets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Portlet> getPortlets(long companyId,
                                                                             boolean showSystem,
                                                                             boolean showPortal)
                                    throws SystemException
Throws:
SystemException

getWARDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletCategory getWARDisplay(java.lang.String servletContextName,
                                                                       java.lang.String xml)
                              throws SystemException
Throws:
SystemException

hasPortlet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasPortlet(long companyId,
                                                            java.lang.String portletId)
                   throws SystemException
Throws:
SystemException

initEAR

void initEAR(javax.servlet.ServletContext servletContext,
             java.lang.String[] xmls,
             PluginPackage pluginPackage)

initWAR

java.util.List<Portlet> initWAR(java.lang.String servletContextName,
                                javax.servlet.ServletContext servletContext,
                                java.lang.String[] xmls,
                                PluginPackage pluginPackage)

updatePortlet

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