com.liferay.portal.service

Class PortletLocalServiceUtil

java.lang.Object

com.liferay.portal.service.PortletLocalServiceUtil

@ProviderType
public class PortletLocalServiceUtil
extends java.lang.Object

Provides the local service utility for Portlet. This utility wraps com.liferay.portal.service.impl.PortletLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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:

PortletLocalService, PortletLocalServiceBaseImpl, com.liferay.portal.service.impl.PortletLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
PortletLocalServiceUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static Portlet	addPortlet(Portlet portlet) Adds the portlet to the database.
static void	addPortletCategory(long companyId, java.lang.String categoryName)
static void	checkPortlet(Portlet portlet)
static void	checkPortlets(long companyId)
static void	clearCache()
static void	clearCompanyPortletsPool()
static Portlet	clonePortlet(long companyId, java.lang.String portletId) Deprecated. As of 6.1.0, replaced by clonePortlet(String)
static Portlet	clonePortlet(java.lang.String portletId)
static Portlet	createPortlet(long id) Creates a new portlet with the primary key.
static Portlet	deletePortlet(long id) Deletes the portlet with the primary key from the database.
static void	deletePortlet(long companyId, java.lang.String portletId, long plid)
static Portlet	deletePortlet(Portlet portlet) Deletes the portlet from the database.
static void	deletePortlets(long companyId, java.lang.String[] portletIds, long plid)
static Portlet	deployRemotePortlet(Portlet portlet, java.lang.String categoryName)
static Portlet	deployRemotePortlet(Portlet portlet, java.lang.String[] categoryNames)
static void	destroyPortlet(Portlet portlet)
static void	destroyRemotePortlet(Portlet portlet)
static DynamicQuery	dynamicQuery()
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static java.util.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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static Portlet	fetchPortlet(long id)
static java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static java.util.List<CustomAttributesDisplay>	getCustomAttributesDisplays()
static PortletCategory	getEARDisplay(java.lang.String xml)
static java.util.List<Portlet>	getFriendlyURLMapperPortlets()
static java.util.List<FriendlyURLMapper>	getFriendlyURLMappers()
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static Portlet	getPortlet(long id) Returns the portlet with the primary key.
static PortletApp	getPortletApp(java.lang.String servletContextName)
static Portlet	getPortletById(long companyId, java.lang.String portletId)
static Portlet	getPortletById(java.lang.String portletId)
static Portlet	getPortletByStrutsPath(long companyId, java.lang.String strutsPath)
static java.util.List<Portlet>	getPortlets()
static java.util.List<Portlet>	getPortlets(int start, int end) Returns a range of all the portlets.
static java.util.List<Portlet>	getPortlets(long companyId)
static java.util.List<Portlet>	getPortlets(long companyId, boolean showSystem, boolean showPortal)
static int	getPortletsCount() Returns the number of portlets.
static java.util.List<Portlet>	getScopablePortlets()
static PortletLocalService	getService()
static PortletCategory	getWARDisplay(java.lang.String servletContextName, java.lang.String xml)
static boolean	hasPortlet(long companyId, java.lang.String portletId)
static void	initEAR(javax.servlet.ServletContext servletContext, java.lang.String[] xmls, PluginPackage pluginPackage)
static java.util.List<Portlet>	initWAR(java.lang.String servletContextName, javax.servlet.ServletContext servletContext, java.lang.String[] xmls, PluginPackage pluginPackage)
static java.util.Map<java.lang.String,Portlet>	loadGetPortletsPool(long companyId)
static void	removeCompanyPortletsPool(long companyId)
static void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(PortletLocalService service) Deprecated. As of 6.2.0
static Portlet	updatePortlet(long companyId, java.lang.String portletId, java.lang.String roles, boolean active)
static Portlet	updatePortlet(Portlet portlet) Updates the portlet in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletLocalServiceUtil

public PortletLocalServiceUtil()

Method Detail

addPortlet

public static Portlet addPortlet(Portlet portlet)
                          throws SystemException

Adds the portlet to the database. Also notifies the appropriate model listeners.

Parameters:

portlet - the portlet

Returns:

the portlet that was added

Throws:

SystemException - if a system exception occurred

createPortlet

public static 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

public static Portlet 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

Returns:

the portlet that was removed

Throws:

PortalException - if a portlet with the primary key could not be found

SystemException - if a system exception occurred

deletePortlet

public static Portlet deletePortlet(Portlet portlet)
                             throws SystemException

Deletes the portlet from the database. Also notifies the appropriate model listeners.

Parameters:

portlet - the portlet

Returns:

the portlet that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                                   throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static java.util.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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PortletModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static java.util.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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PortletModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchPortlet

public static Portlet fetchPortlet(long id)
                            throws SystemException

Throws:

SystemException

getPortlet

public static Portlet getPortlet(long id)
                          throws PortalException,
                                 SystemException

Returns the portlet with the primary key.

Parameters:

id - the primary key of the portlet

Returns:

the portlet

Throws:

PortalException - if a portlet with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getPortlets

public static java.util.List<Portlet> getPortlets(int start,
                                  int end)
                                           throws SystemException

Returns 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PortletModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of portlets

end - the upper bound of the range of portlets (not inclusive)

Returns:

the range of portlets

Throws:

SystemException - if a system exception occurred

getPortletsCount

public static int getPortletsCount()
                            throws SystemException

Returns the number of portlets.

Returns:

the number of portlets

Throws:

SystemException - if a system exception occurred

updatePortlet

public static Portlet updatePortlet(Portlet portlet)
                             throws SystemException

Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

portlet - the portlet

Returns:

the portlet that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addPortletCategory

public static void addPortletCategory(long companyId,
                      java.lang.String categoryName)

checkPortlet

public static void checkPortlet(Portlet portlet)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

checkPortlets

public static void checkPortlets(long companyId)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

clearCache

public static void clearCache()

clearCompanyPortletsPool

public static void clearCompanyPortletsPool()

clonePortlet

public static Portlet clonePortlet(long companyId,
                   java.lang.String portletId)

Deprecated. As of 6.1.0, replaced by clonePortlet(String)

clonePortlet

public static Portlet clonePortlet(java.lang.String portletId)

deletePortlet

public static void deletePortlet(long companyId,
                 java.lang.String portletId,
                 long plid)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

deletePortlets

public static void deletePortlets(long companyId,
                  java.lang.String[] portletIds,
                  long plid)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deployRemotePortlet

public static Portlet deployRemotePortlet(Portlet portlet,
                          java.lang.String categoryName)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

deployRemotePortlet

public static Portlet deployRemotePortlet(Portlet portlet,
                          java.lang.String[] categoryNames)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

destroyPortlet

public static void destroyPortlet(Portlet portlet)

destroyRemotePortlet

public static void destroyRemotePortlet(Portlet portlet)

getCustomAttributesDisplays

public static java.util.List<CustomAttributesDisplay> getCustomAttributesDisplays()

getEARDisplay

public static PortletCategory getEARDisplay(java.lang.String xml)
                                     throws SystemException

Throws:

SystemException

getFriendlyURLMapperPortlets

public static java.util.List<Portlet> getFriendlyURLMapperPortlets()

getFriendlyURLMappers

public static java.util.List<FriendlyURLMapper> getFriendlyURLMappers()

getPortletApp

public static PortletApp getPortletApp(java.lang.String servletContextName)

getPortletById

public static Portlet getPortletById(long companyId,
                     java.lang.String portletId)
                              throws SystemException

Throws:

SystemException

getPortletById

public static Portlet getPortletById(java.lang.String portletId)

getPortletByStrutsPath

public static Portlet getPortletByStrutsPath(long companyId,
                             java.lang.String strutsPath)
                                      throws SystemException

Throws:

SystemException

getPortlets

public static java.util.List<Portlet> getPortlets()

getPortlets

public static java.util.List<Portlet> getPortlets(long companyId)
                                           throws SystemException

Throws:

SystemException

getPortlets

public static java.util.List<Portlet> getPortlets(long companyId,
                                  boolean showSystem,
                                  boolean showPortal)
                                           throws SystemException

Throws:

SystemException

getScopablePortlets

public static java.util.List<Portlet> getScopablePortlets()

getWARDisplay

public static PortletCategory getWARDisplay(java.lang.String servletContextName,
                            java.lang.String xml)
                                     throws SystemException

Throws:

SystemException

hasPortlet

public static boolean hasPortlet(long companyId,
                 java.lang.String portletId)
                          throws SystemException

Throws:

SystemException

initEAR

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

initWAR

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

loadGetPortletsPool

public static java.util.Map<java.lang.String,Portlet> loadGetPortletsPool(long companyId)
                                                                   throws SystemException

Throws:

SystemException

removeCompanyPortletsPool

public static void removeCompanyPortletsPool(long companyId)

updatePortlet

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

Throws:

SystemException

getService

public static PortletLocalService getService()

setService

public void setService(PortletLocalService service)

Deprecated. As of 6.2.0