Liferay 6.0.5

com.liferay.portal.service
Interface PortletLocalService

All Known Implementing Classes:
PortletLocalServiceBaseImpl, PortletLocalServiceImpl, PortletLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface PortletLocalService

The interface for the portlet local service.

Never modify or reference this interface directly. Always use PortletLocalServiceUtil to access the portlet local service. Add custom service methods to PortletLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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.

See Also:
PortletLocalServiceUtil, PortletLocalServiceBaseImpl, PortletLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 Portlet addPortlet(Portlet portlet)
          Adds the portlet to the database.
 void checkPortlet(Portlet portlet)
           
 void checkPortlets(long companyId)
           
 void clearCache()
           
 Portlet clonePortlet(long companyId, String portletId)
           
 Portlet createPortlet(long id)
          Creates a new portlet with the primary key.
 void deletePortlet(long id)
          Deletes the portlet with the primary key from the database.
 void deletePortlet(Portlet portlet)
          Deletes the portlet from the database.
 Portlet deployRemotePortlet(Portlet portlet, String categoryName)
           
 void destroyPortlet(Portlet portlet)
           
 void destroyRemotePortlet(Portlet portlet)
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Counts the number of rows that match the dynamic query.
 List<CustomAttributesDisplay> getCustomAttributesDisplays()
           
 PortletCategory getEARDisplay(String xml)
           
 List<Portlet> getFriendlyURLMapperPortlets()
           
 List<FriendlyURLMapper> getFriendlyURLMappers()
           
 Portlet getPortlet(long id)
          Gets the portlet with the primary key.
 PortletApp getPortletApp(String servletContextName)
           
 Portlet getPortletById(long companyId, String portletId)
           
 Portlet getPortletById(String portletId)
           
 Portlet getPortletByStrutsPath(long companyId, String strutsPath)
           
 List<Portlet> getPortlets()
           
 List<Portlet> getPortlets(int start, int end)
          Gets a range of all the portlets.
 List<Portlet> getPortlets(long companyId)
           
 List<Portlet> getPortlets(long companyId, boolean showSystem, boolean showPortal)
           
 int getPortletsCount()
          Gets the number of portlets.
 PortletCategory getWARDisplay(String servletContextName, String xml)
           
 boolean hasPortlet(long companyId, String portletId)
           
 void initEAR(javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage)
           
 List<Portlet> initWAR(String servletContextName, javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage)
           
 Portlet updatePortlet(long companyId, String portletId, String roles, boolean active)
           
 Portlet updatePortlet(Portlet portlet)
          Updates the portlet in the database.
 Portlet updatePortlet(Portlet portlet, boolean merge)
          Updates the portlet in the database.
 

Method Detail

addPortlet

Portlet addPortlet(Portlet portlet)
                   throws SystemException
Adds the portlet to the database. Also notifies the appropriate model listeners.

Parameters:
portlet - the portlet to add
Returns:
the portlet that was added
Throws:
SystemException - if a system exception occurred

createPortlet

Portlet createPortlet(long id)
Creates a new portlet with the primary key. Does not add the portlet to the database.

Parameters:
id - the primary key for the new portlet
Returns:
the new portlet

deletePortlet

void deletePortlet(long id)
                   throws PortalException,
                          SystemException
Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
id - the primary key of the portlet to delete
Throws:
PortalException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred

deletePortlet

void deletePortlet(Portlet portlet)
                   throws SystemException
Deletes the portlet from the database. Also notifies the appropriate model listeners.

Parameters:
portlet - the portlet to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getPortlet

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Portlet getPortlet(long id)
                   throws PortalException,
                          SystemException
Gets the portlet with the primary key.

Parameters:
id - the primary key of the portlet to get
Returns:
the portlet
Throws:
PortalException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred

getPortlets

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Portlet> getPortlets(int start,
                                                                   int end)
                          throws SystemException
Gets a range of all the portlets.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
start - the lower bound of the range of portlets to return
end - the upper bound of the range of portlets to return (not inclusive)
Returns:
the range of portlets
Throws:
SystemException - if a system exception occurred

getPortletsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPortletsCount()
                     throws SystemException
Gets the number of portlets.

Returns:
the number of portlets
Throws:
SystemException - if a system exception occurred

updatePortlet

Portlet updatePortlet(Portlet portlet)
                      throws SystemException
Updates the portlet in the database. Also notifies the appropriate model listeners.

Parameters:
portlet - the portlet to update
Returns:
the portlet that was updated
Throws:
SystemException - if a system exception occurred

updatePortlet

Portlet updatePortlet(Portlet portlet,
                      boolean merge)
                      throws SystemException
Updates the portlet in the database. Also notifies the appropriate model listeners.

Parameters:
portlet - the portlet to update
merge - whether to merge the portlet with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the portlet that was updated
Throws:
SystemException - if a system exception occurred

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,
                     String portletId)
                     throws SystemException
Throws:
SystemException

deployRemotePortlet

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

destroyPortlet

void destroyPortlet(Portlet portlet)

destroyRemotePortlet

void destroyRemotePortlet(Portlet portlet)

getCustomAttributesDisplays

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

getEARDisplay

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

getFriendlyURLMapperPortlets

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

getFriendlyURLMappers

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

getPortletApp

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

getPortletById

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

getPortletById

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

getPortletByStrutsPath

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

getPortlets

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

getPortlets

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

getPortlets

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

getWARDisplay

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

hasPortlet

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

initEAR

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

initWAR

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

updatePortlet

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

Liferay 6.0.5